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

Rework docs #437

Merged
merged 7 commits into from
Nov 1, 2021
Merged

Rework docs #437

merged 7 commits into from
Nov 1, 2021

Conversation

davidpdrsn
Copy link
Member

This reworks axum's docs in an attempt to make things easier to find. Previously I wasn't a fan of those docs for the same topic were spread across the root module docs and more specific places like types and methods.

This changes it such that the root module docs only gives a high level introduction to a topic, perhaps with a small example, and then link to other places where all the details are. This means Router is now the single place to learn about routing, and etc for the topics like handlers and error handling.

@davidpdrsn davidpdrsn added the T-docs Topic: documentation label Oct 31, 2021
@davidpdrsn davidpdrsn added this to the 0.3 milestone Oct 31, 2021
@davidpdrsn davidpdrsn marked this pull request as ready for review November 1, 2021 15:24
Not needed for axum itself, only examples
@davidpdrsn davidpdrsn enabled auto-merge (squash) November 1, 2021 21:11
@davidpdrsn davidpdrsn merged commit 9465128 into main Nov 1, 2021
@davidpdrsn davidpdrsn deleted the docs branch November 1, 2021 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant