-
Notifications
You must be signed in to change notification settings - Fork 49
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
Documentation migration #468
Conversation
Following the Diataxis structure, existing *.rst documents are migrated under the section they represent better. Only one file is not migrated: checkbox-ng/docs/snappy.rst because its content is really outdated. Fixes CHECKBOX-610
2db9a55
to
79178e1
Compare
The "Spelling check" steps of our workflow fails because of a lot of technical terms in our pages. Will have to look into that later. |
Good work, just one comment. I'd not create a section for "Project and community" (on the left side bar) but rather add both bugs.rst and contributing.rst as links under the footer section of the main page, right here:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add :orphan: to the top of the following files:
- checkbox/docs/community/bugs.rst
- checkbox/docs/community/contributing.rst
To avoid a warning at build time:
WARNING: document isn't included in any toctree
Done! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
The goal of this PR is to migrate our existing pages to the new
docs
directory, and do some cleanup. Namely:I migrated everything except
snappy.rst
as I thought it was not relevant anymore (checkbox-snappy is not in use, and the content of that page is basically a mega-tutorial with information present elsewhere).Resolved issues
CHECKBOX-610
Tests
Tested locally using
make run
(super useful stuff!)I checked if images and links worked as before, and it seems OK.
To test locally:
docs/
directory, and runmake install
make run
-> you should be able to access the built documentation locally.