-
Notifications
You must be signed in to change notification settings - Fork 96
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
draft index.rst for CORE-V Docs #521
Conversation
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'm liking this idea! Recommend we put this into it's own top-level directory (RTD defaults to "docs", but we can call it anything we want.) We could also move the idcodes.md
into the same directory and make it a section of the RTD rendering.
@MikeOpenHWGroup - I'm not sure what you're asking for. You want the index for core-v-docs inside a subdirectory called /docs (core-v-docs/docs/)? Seems like unnecessary nesting IMHO. I agree about including the idcodes.md which is a change we can make after the PR is merged as there's a bunch of further changes / additions to make... |
Agree that |
ok - fair enough. So, let's go with /DocsIndex then. Is it best that I cancel this PR and re-issue a new PR with everything in /DocsIndex? |
I am "pretty sure" you can make the changes in your current working copy and then commit/push onto the rickoco:master branch of your fork. The PR is updated accordingly. |
So turns out 'index.rst' needs to be in the repo root or '\docs' directory. I've moved everything to '\docs' and will let you know when to merge after some rendering testing with rtd. don't merge yet |
Fixed up file locations, some formatting and added images. More formatting and content to be added, but ready to merge now... https://openhw-group-core-v-docs-dev.readthedocs-hosted.com/en/latest/index.html |
building on work done previously by @davideschiavone , this PR is the start of creating an Index landing page for all CORE-V related documentation. A readthedocs rendering can be seen here https://openhw-group-core-v-docs-dev.readthedocs-hosted.com/en/latest/