5238 set up basic docs structure#5245
Conversation
There was a problem hiding this comment.
This can just be the user guide.
There was a problem hiding this comment.
Sure, I'll just copy paste it in there for now. We should probably split it up at some point though.
There was a problem hiding this comment.
Ah sorry, I mis-read you. Yep, will fix the link
a95a842 to
5a0bd94
Compare
|
Can we figure out a way to avoid a super visible Something like |
|
Unfortunately, that seems to be a hard requirement from docusaurus. We could, however, move the entire website folder into a new location, as all docusaurus is asking for is a folder named «docs» as a sibling to the «website» folder. How about this:
Sounds like a plan? |
|
Okay that sounds good. |
This commit adds a temporary readme file that points users to the main README file or the User Guide.
This commit adds a page for getting started, copying the "Get started now" from the current `README.md`.
8f54c0e to
8dbf494
Compare
|
I merged this into master but I also pushed a I agree it probably makes more sense to start working in it directly than create noise on master. How about this arrangement:
|
|
Also thanks again for working on this, I'm super excited we'll get a real website! |
|
sounds good, thanks! |
|
Good by me as well :) go team! |
This pull request adds two docs sections - "Getting Started" and "User Guide".
The "Getting Started" part is just a copy of parts of the main README for now, while the "User Guide" just links to the user guide found on GitHub.
And with this - we can actually start the project locally!
Adresses #5238