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

Restructure docs. #566

Merged
merged 1 commit into from
Jun 27, 2021
Merged

Restructure docs. #566

merged 1 commit into from
Jun 27, 2021

Conversation

dbrumann
Copy link
Collaborator

@dbrumann dbrumann commented Jun 5, 2021

  • Splits up README.md into multiple documents
  • Adds Contribution Guide explaining the how to run tests locally
  • Updates parts of README.md

Probably best reviewed by looking at the resulting docs on my branch: https://github.com/dbrumann/deptrac/tree/restructure_docs

Rationale

The README.md file has become quite large. The table of contents helps with finding sections, but I would like keep the file short with only the necessities for getting started and then provide more in depth documentation in the docs/ folder.

Open To Dos

  • Possibly move parts the section Run deptrac in the README.md into docs/ (e.g. a separate page for depfile where parameters and sections are fully explained or an overview of all available commands)
  • Add a table of contents to pages in docs
  • Add links between pages in docs for easier navigation?

@dbrumann dbrumann force-pushed the restructure_docs branch 3 times, most recently from 0e77be3 to e5257a3 Compare June 5, 2021 18:54
@dbrumann dbrumann force-pushed the restructure_docs branch 7 times, most recently from 2c2981a to 40b7f77 Compare June 27, 2021 09:58
 * Splits up README.md into multiple documents
 * Adds Contribution Guide explaining the how to run tests locally
 * Updates parts of README.md in their dedicated sections
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant