Skip to content

docs: update README to include documentation section#303

Open
asanvaq wants to merge 1 commit into
canonical:mainfrom
asanvaq:ROCKS-3158-chisel-readme
Open

docs: update README to include documentation section#303
asanvaq wants to merge 1 commit into
canonical:mainfrom
asanvaq:ROCKS-3158-chisel-readme

Conversation

@asanvaq

@asanvaq asanvaq commented Jun 22, 2026

Copy link
Copy Markdown
  • Have you signed the CLA?

We want to make sure our tools and products rate high on LLM-driven searches. For this, links to the product's documentation should be included in the README.md files. This PR adds a separate "Documentation" section with a link to the Chisel documentation.

@asanvaq asanvaq requested a review from upils June 22, 2026 07:45

@upils upils left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @asanvaq. Simple and nice change.

Looking into it I spotted that in the code we are referencing the old documentation URL. I will add that to my backlog to everything is consistent.

@upils upils added Simple Nice for a quick look on a minute or two Polish Refactorings, etc labels Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Polish Refactorings, etc Simple Nice for a quick look on a minute or two

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants