docs: Polished Markdown files

[danwilliams]

Polished Markdown files

• Reflowed Markdown files to align to common standards for authoring, aiding source readability.

• Added links and link references.

• Corrected typos for spelling etc.

• Linked to the license file from Cargo.toml.

Summary by CodeRabbit

• Documentation
  • Restructured and refined content for better clarity and readability in CODE_OF_CONDUCT.md, CONTRIBUTING.md, CONTRIBUTORS.md, README.mdx, and crates/identity/README.md.
  • Added the license-file field pointing to LICENSE.md in Cargo.toml.
  • Refactored accountability rules for parsers in crates/sdk/macros/design-guide.md.

[coderabbitai]

Walkthrough

The changes across various files focus on enhancing readability, clarity, and structure. From refining language and breaking down content to adding hyperlinks and restructuring guidelines, the modifications aim to improve communication and user experience. Additionally, updates include adding licensing information and refining specific sections for better understanding and usability.

Changes

Files	Changes
CODE_OF_CONDUCT.md, CONTRIBUTING.md, CONTRIBUTORS.md	Refactored text for clarity and added hyperlinks for improved navigation.
Cargo.toml	Added license-file field pointing to LICENSE.md.
README.mdx, crates/identity/README.md	Restructured content for better readability and clarity.
crates/sdk/design-guide.md, crates/sdk/macros/design-guide.md	Enhanced guidelines for parsers, improved language consistency, and clarified instructions.

Poem

A rabbit hops through code so fair,
Refining words with utmost care.
Guiding hands to clearer sights,
Structuring thoughts to reach new heights. 🐇✨

---

Note

Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://coderabbit.ai

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[xilosada]