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: migrate a chunk of documentation over to mkdocs #506

Merged
merged 1 commit into from
Jun 21, 2021
Merged

Conversation

ClementTsang
Copy link
Owner

@ClementTsang ClementTsang commented Jun 21, 2021

Description

A description of the change and what it does. If relevant (such as any change that modifies the UI), please provide screenshots of the change:

A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs.

Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.

Issue

If applicable, what issue does this address?

Closes: #383

Checklist

If relevant, ensure the following have been met:

  • Areas your change affects have been linted using rustfmt (cargo fmt)
  • The change has been tested and doesn't appear to cause any unintended breakage
  • Documentation has been added/updated if needed (README, help menu, etc.)
  • The pull request passes the provided CI pipeline
  • There are no merge conflicts

@ClementTsang ClementTsang force-pushed the docs_v2 branch 8 times, most recently from d1f67e4 to 38d4d66 Compare June 21, 2021 05:31
@ClementTsang ClementTsang changed the title docs: migrate documentation over to mkdocs docs: migratea chunk of documentation over to mkdocs Jun 21, 2021
@ClementTsang ClementTsang changed the title docs: migratea chunk of documentation over to mkdocs docs: migrate a chunk of documentation over to mkdocs Jun 21, 2021
@ClementTsang ClementTsang merged commit 06071d5 into master Jun 21, 2021
@ClementTsang ClementTsang deleted the docs_v2 branch June 21, 2021 05:40
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.

Migrate some documentation to wiki and/or manpages
1 participant