search

cosmos / interchain-security

Interchain Security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.
https://cosmos.github.io/interchain-security/
Other
154 stars 115 forks source link

docs: update ADRs rendering #1937

Closed mpoke closed 3 months ago

mpoke commented 4 months ago

Description

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough This set of changes focuses on updating documentation files for better clarity and organization. Key adjustments include renaming titles and updating links in ADR documents, adding metadata for sidebar positioning, and configuring exclusions in Docusaurus. These enhancements improve readability and navigation within the project documentation files. ## Changes | File(s) | Change Summary | |---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| | `CONTRIBUTING.md` | Updated the path to the ADR template within the documentation links. | | `docs/docs/adrs/adr-004-denom-dos-fixes.md` | Updated the title from "ADR Template" to "Denom DOS fixes". | | `docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md` | Updated the title to "Pause validator unbonding during equivocation proposal". | | `docs/docs/adrs/intro.md` | Changed document title from "ADRs" to "Overview" and updated references and links to Architecture Decision Records. | | `docs/docs/features/democracy-modules.md` \| `docs/docs/features/power-shaping.md` | Added metadata for sidebar position configuration. | | `docs/docs/features/partial-set-security.md` | Updated `sidebar_position` from 5 to 6. | | `docs/docusaurus.config.js` | Added exclusion rule for files matching the pattern `**/templates/*`. |
Recent review details **Configuration used: .coderabbit.yml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between c4d4f05b6262274139aad880fe6815a83ef29c38 and f23599a50ac4bc7d32f028aec00346fdf349b24d.
Files selected for processing (1) * docs/docs/adrs/intro.md (2 hunks)
Additional context used
Path-based instructions (1)
docs/docs/adrs/intro.md (1) Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."
LanguageTool
docs/docs/adrs/intro.md
[uncategorized] ~22-~22: You might be missing the article “a” here. (AI_EN_LECTOR_MISSING_DETERMINER_A) Context: ...hitecture of something new. The spec is much more compressed and streamlined summary...
Markdownlint
docs/docs/adrs/intro.md
6-6: null (MD025, single-title, single-h1) Multiple top-level headings in the same document
Additional comments not posted (4)
docs/docs/adrs/intro.md (4)
`3-3`: **Title Update Approved** The title change from "ADRs" to "Overview" is appropriate and accurately reflects the document's purpose as an introduction to Architecture Decision Records. --- `29-29`: **Link Update Approved** The update to the link for the ADR template to point to the new location in the `templates` directory is correct and reflects the changes made in the repository structure. --- `26-26`: **Grammar Improvement Suggestion** As previously discussed, adding a comma after "match" could improve readability, but the suggested change was skipped due to low confidence. Re-evaluating the sentence, the comma seems unnecessary, and readability is acceptable as is. --- `10-10`: **Grammar Check: Addition of an Article** The sentence "The spec is much more compressed and streamlined summary of everything as it is or should be" is missing an article before "summary". This would enhance clarity and grammatical correctness. ```diff - The spec is much more compressed and streamlined summary of everything as it is or should be. + The spec is a much more compressed and streamlined summary of everything as it is or should be. ``` > Likely invalid or redundant comment.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.