Skip to content

docs: update README to include documentation section - #303

Merged
niemeyer merged 1 commit into
canonical:mainfrom
asanvaq:ROCKS-3158-chisel-readme
Jul 6, 2026
Merged

niemeyer merged 1 commit into
canonical:mainfrom
asanvaq:ROCKS-3158-chisel-readme

Conversation

@asanvaq

@asanvaq asanvaq commented Jun 22, 2026 •

Copy link
Copy Markdown
Contributor
  • 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

@niemeyer niemeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks indeed!

@niemeyer
niemeyer merged commit ea61b84 into canonical:main Jul 6, 2026
18 checks passed
@ROCKsBot

ROCKsBot commented Jul 6, 2026

Copy link
Copy Markdown
Command Mean [s] Min [s] Max [s] Relative
BASE 15.117 ± 0.166 14.917 15.353 1.01 ± 0.01
HEAD 14.979 ± 0.080 14.856 15.117 1.00

@asanvaq
asanvaq deleted the ROCKS-3158-chisel-readme branch July 7, 2026 05:08
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.

4 participants