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

Register spec web page needed for 1.x #605

Open
nquarton opened this issue Oct 22, 2024 · 3 comments
Open

Register spec web page needed for 1.x #605

nquarton opened this issue Oct 22, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@nquarton
Copy link
Contributor

The register spec web page looks like it's starting to reflect 2.0 changes. I'm not able to find a reference for 1.1 and 1.0. I thought it might be https://chipsalliance.github.io/caliptra-rtl/patch_v1.1/internal-regs/?p= but that doesn't seem to exist.

Is it possible to have the register specs published from both the 1.0 and 1.1 branch?

@calebofearth calebofearth added the documentation Improvements or additions to documentation label Oct 24, 2024
@nquarton
Copy link
Contributor Author

nquarton commented Nov 7, 2024

Just wanted to check if there is any idea when this could be addressed. (And if there is at least agreement this should continue to be supported for 1.x.)

@calebofearth
Copy link
Collaborator

Hey Nick, I agree this should be addressed but will have to be pushed out past the RTL feature freeze for 2.0.

This requires an update to the release checklist, plus we'll have to make a commit against the 1.X READMEs and workflow files once we have a fix in place, to point to the correct generated pages. If you want to take on this work, please feel free 😉

@jhand2
Copy link

jhand2 commented Nov 8, 2024

One possibility is during the workflow that generates the docs, we could checkout the 1.0 and 1.1 branches to also generate docs for those. But the workflow would still only exist on the main branch.

I looked into this a couple weeks ago, but I wasn't able to come up with a nice with to generate HTML to handle this. Ideally we would have a single page where you could select hw revision from a dropdown. But maybe we can do something more simple in the short term.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants