Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Documentation reorg #1119
Documentation reorg #1119
Comments
|
working on this |
Reorganize the existing documentation in the Intern repo. The goal of this issue isn't to substantially rewrite or add documentation (not all of the topics in the example below exist yet), but to reorganize and prune the existing docs in preparation for future updates.
See #1088 for discussion.
The overall structure should end up like:
Documentation will still be kept in the
docs/directory in the repo. The overall table of contents should remain in the README; currently it's in a "More Information" section, which should be renamed to "Documentation".Within the docs directory, individual topics should generally be one per file. If a group of related topics are short, or it makes sense for them to be read continuously, they can go in one file. The "getting started" topics should probably be in the doc root, the guides can go in a "guides" subdirectory, and API docs can go in an "api" subdirectory.