README: split authoring documentation into a doc/ directory #2345
+254
−232
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey, sorry I didn't keep you updated in the original issue, but since I didn't have news from your side, I started working on a documentation rework in #2164. I think it would be better if we collaborated on this other PR, so feel free to give your input there. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The toplevel README.md file is getting too long. The present PR splits most of its content in
doc/foo.mddocumentation pages, along the lines discussed with @elegaanz in #2024 (comment) . Basically, the documentation for users of packages remains in README.md, and the documentation for authors of packages is moved -- with a mention in the README.I decided to only restructure the documentation, and not change its content -- I have some idea for content changes but they could come in separate PRs once the structure is in place.
Some of the user documentation feels like a point of detail to me (in particular the discussion on where packages are downloaded; who cares?), and I wondered about also moving this content to
doc/...subpages, or removing it altogether.