Skip to content

WIP docs: align README with new Chisel docs - #191

Draft
cjdcordeiro wants to merge 2 commits into
canonical:mainfrom
cjdcordeiro:align-with-chisel-docs
Draft

cjdcordeiro wants to merge 2 commits into
canonical:mainfrom
cjdcordeiro:align-with-chisel-docs

Conversation

@cjdcordeiro

Copy link
Copy Markdown
Collaborator
  • Have you signed the CLA?

WIP: some of the README's contents (e.g. the Pro example) are still missing from the Chisel docs. Once we make sure the docs comprise everything that is in this README, we'll update this PR and significantly reduce this repo's README and point to the Chisel docs instead.

@cjdcordeiro
cjdcordeiro marked this pull request as draft January 14, 2025 11:43
@upils

upils commented Oct 22, 2026

Copy link
Copy Markdown
Collaborator

@cjdcordeiro do you still want to do anything with this PR? We now have an how-to for Pro at https://ubuntu.com/chisel/docs/latest/how-to/install-pro-package-slices/ and a link in the README to the docs.

@cjdcordeiro

Copy link
Copy Markdown
Collaborator Author

@cjdcordeiro do you still want to do anything with this PR? We now have an how-to for Pro at https://ubuntu.com/chisel/docs/latest/how-to/install-pro-package-slices/ and a link in the README to the docs.

the badge would still be a nice little addition, but that's not why the PR is in WIP.
Originally, I wanted to refactor this README, cause atm it's duplicating some of the official docs' content, which isn't nice. It never became priority high enough to spend our time on it. But I think it's worth doing.

@asanvaq

asanvaq commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

I added this to my backlog of issues!

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.

3 participants