Restructure and Update Documentation #987
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alex-mckenna
requested review from
christiaanb,
leonschoorl and
martijnbastiaan
alex-mckenna
force-pushed
the
readthedocs-writethedocs
branch
2 times, most recently
from
b069a9c
to
0b415c6
Compare
|
Given this PR appears to be getting a bit lost, I'm going to suggest merging what exists currently and going back for any other changes later. EDIT This branch rendered lives at https://clash-lang.readthedocs.io/en/readthedocs-writethedocs/ |
WIP. I want to structure the documentation into parts that affect different users, and provide a more intuitive way to drill down to topics different types of user will be interested in. The main areas I see so far are * general info (what is the project, license, FAQ etc.) * how to use clash / clashi * how to develop using clash language * advanced topics (how can I be a clash power user) * information about the community, contributing etc.
martijnbastiaan
force-pushed
the
readthedocs-writethedocs
branch
from
0b415c6
to
6bbea42
Compare
martijnbastiaan
approved these changes
Mar 2, 2020
There was a problem hiding this comment.
I'm happy. @christiaanb could you double check the FAQ answers I added in the second commit of this PR?
martijnbastiaan
force-pushed
the
readthedocs-writethedocs
branch
3 times, most recently
from
61f3d4b
to
76dc4a1
Compare
martijnbastiaan
force-pushed
the
readthedocs-writethedocs
branch
from
76dc4a1
to
17fa877
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR continues the work from #980 by updating the documentation for Clash on readthedocs. The documentation now contains the following contents, which should be valid for the current version of Clash:
To prevent duplication of things like installation instructions, changelog etc. these are included into the documentation from the toplevel directory (as GitHub does not support
includedirectives in reStructuredText files). This means the toplevel files are changed from Markdown to reStructuredText.Still to do:
(:>)andConsforVec n a(fixes Document differences between:>andCons#968)-fclash-old-inline-strategyflagPut the QBayLogic logo on the docs page, maybe make the colour scheme orangeLet's develop a logo first :P