Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: address feedback in examples and default values #75

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

hopeyen
Copy link
Collaborator

@hopeyen hopeyen commented Apr 15, 2024

Description

  • example configurations file - template.toml file use a valid example-file location. From the repo it is at ./example-file when running at project root
  • publisher docs - example cli update output-dir -> main-dir
  • downloader docs - ping the default indexer server endpoint http://localhost:7600
  • server docs - config file should refer to a valid location from the project root --config ./template.toml

Issue link (if applicable)

Resolves #60

Checklist

  • Are tests up-to-date with the new changes?
  • Are docs up-to-date with the new changes? (Open PR on docs repo if necessary)

@hopeyen hopeyen added type:documentation Improvements or additions to documentation size:small Small p2 Medium priority labels Apr 15, 2024
@hopeyen hopeyen requested a review from pete-eiger April 15, 2024 22:01
@hopeyen hopeyen self-assigned this Apr 15, 2024
@hopeyen hopeyen force-pushed the hope/docs-feedback branch from ee81029 to c4cfc0c Compare April 15, 2024 22:06
Copy link

github-actions bot commented Apr 18, 2024

Pull Request Test Coverage Report for Build 8802816649

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 0.0%

Totals Coverage Status
Change from base Build 8787354341: 0.0%
Covered Lines: 0
Relevant Lines: 4508

💛 - Coveralls

pete-eiger
pete-eiger previously approved these changes Apr 23, 2024
Copy link

@pete-eiger pete-eiger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@hopeyen hopeyen force-pushed the hope/docs-feedback branch from c4cfc0c to 11345d5 Compare April 23, 2024 15:09
@hopeyen hopeyen merged commit f75543d into dev Apr 23, 2024
5 checks passed
@hopeyen hopeyen deleted the hope/docs-feedback branch April 23, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2 Medium priority size:small Small type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feat: Docs update
2 participants