-
Notifications
You must be signed in to change notification settings - Fork 382
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
Installation, Quickstart Guide and Sphynx Overhaul #1259
Conversation
armleo
commented
Aug 10, 2022
•
edited by donn
Loading
edited by donn
- Documentation changed, README no longer documentation's landing page
- New installation and quickstart guides created
made some correction
Update broken links to respective docs
@vijayank88 Did you test the changes in the RTD? Why change warnings to warnings. They are not as eye catching as the red message. Maybe we can make it more eye catching by making changes to CSS instead? |
@armleo So highlight someway unique to view both the end. I fixed the broken links of I didn't fully completed readthedocs.io review. Only quickstart and installation docs reviewed. |
That is correct. But the docs are not supposed to be viewed with GitHub UI. All of the docs will migrate to .rst + RTD. RST is not supported properly by GitHub. Everything else is fine. |
Ready for merge once CI passes. |
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.
I had to do some copywriting, but otherwise, pretty good. I do expect the remaining markdown files in docs/
to be converted to rst
as well, eventually.
@armleo Can you confirm is the |
I spent entirely too much time copywriting mw3. You'll have to rebase mw4 and open a new PR. |