docs: fix link, markdown, code block highlighting #1375
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
Updates documentation for clarity and consistency, adds syntax highlighting to code blocks, fixes an outdated link, and ignores extra build artifacts in Docker.
- Add language hints to code blocks across docs and fix a JSON example typo
- Update the public test results link in docs/overview.md
- Ignore cmd/hivechain and cmd/hiveview binaries in .dockerignore
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/simulators.md | Adds language-specific code fences, fixes a JSON key typo, and improves formatting for examples |
| docs/overview.md | Replaces outdated test results links with the current canonical URL |
| docs/clients.md | Cleans up excess blank lines for markdown linting |
| README.md | Normalizes heading levels and removes stray blank line |
| .dockerignore | Adds hivechain and hiveview binaries to ignored artifacts |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is mostly just updating the docs to provide syntax highlighting for most of the code blocks and to fix some markdown lint issues. It's also fixing a link to hive testing results, and adding cmd/hivechain and cmd/hiveview build artifacts to the
.dockerignoreand.gitignorefiles.You can preview the
docs/simulators.mdto see the changes in github.