Skip to content
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

Merged
merged 38 commits into from
Apr 1, 2022
Merged

Conversation

rickoco
Copy link
Contributor

@rickoco rickoco commented Mar 30, 2022

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/

Copy link
Member

@MikeOpenHWGroup MikeOpenHWGroup left a 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.

@rickoco
Copy link
Contributor Author

rickoco commented Mar 31, 2022

@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...

@MikeOpenHWGroup
Copy link
Member

Agree that core-v-docs/docs is a bit odd, so a better name for the sub-dir would be good (LandingPageIndex, maybe?). I do not see it as unnecessary nesting. We've already got three files: cores.rst, index.rst and idcodes.md (previously contributed by Florian). Its a good bet that we'll want to add more and over a short period of time that will lead to a lot of files clustering the top-level.

@rickoco
Copy link
Contributor Author

rickoco commented Mar 31, 2022

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?

@MikeOpenHWGroup
Copy link
Member

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.

@rickoco
Copy link
Contributor Author

rickoco commented Apr 1, 2022

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

@rickoco
Copy link
Contributor Author

rickoco commented Apr 1, 2022

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

@MikeOpenHWGroup MikeOpenHWGroup self-requested a review April 1, 2022 20:27
@MikeOpenHWGroup MikeOpenHWGroup merged commit 08f1891 into openhwgroup:master Apr 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants