docs: update

[distractedm1nd]

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced documentation with new sections explaining "What is Prism?", "Why Prism?", and "How does it work?" to improve user understanding.
  • Added resources for users, including links to relevant podcasts and livestreams.
  • Introduced visual representations of the architecture in documentation to clarify system interactions.

• Bug Fixes

  • Updated content to reflect the current development status as of November 12th, 2024, ensuring accuracy across all documents.

• Documentation

  • Streamlined and clarified explanations of cryptographic concepts and security implications related to Prism.
  • Removed outdated sections and content to focus on relevant information.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant modifications to various documentation files related to the Prism project. Key changes include the replacement of Mermaid diagrams with static images, the addition of new content sections explaining Prism's functionality, and updates to existing text for clarity and relevance. New sections on resources such as podcasts and livestreams were added, while some previous content was removed or restructured to enhance user engagement and understanding of the authentication standard.

Changes

File Path	Change Summary
doc/book/architecture.html	Removed Mermaid diagram; replaced with an image (architecturehor-08.png).
doc/book/index.html	Added new sections: "What is Prism?", "Why Prism?", "How does it work?"; restructured content.
doc/book/print.html	Added sections: "What is Prism?", "Why Prism?", "How does it work?", "The Authentication Challenge"; updated content for clarity.
doc/book/quickstart.html	Revised content to emphasize Prism's importance; introduced sections on "Authentication Challenge" and "Split-World Vulnerability."
doc/book/resources.html	Added new sections: "Podcasts" and "Livestreams"; removed "Other Resources."
doc/book/rollup.html	Added image (architecturehor-08.png) to describe Prism's operation; no other structural changes.
doc/book/state.html	Updated content to reflect current development status; revised sections on circuits and optimizations.
doc/src/README.md	Added sections: "What is Prism?", "Why Prism?", "How does it work?"; restructured use cases.
doc/src/architecture.md	Replaced text-based architecture explanation with a graphical representation.
doc/src/quickstart.md	Revised introduction; focused on authentication challenges and vulnerabilities.
doc/src/resources.md	Added sections: "Podcasts" and "Livestreams"; removed "Other Resources."
doc/src/rollup.md	Added image illustrating Prism's architecture; maintained existing content structure.
doc/src/state.md	Updated development status; revised sections on circuits and state tree optimizations.

Possibly related PRs

• feat(WIP): secp256k1-support, rename PublicKey to VerifyingKey #134: Involves renaming PublicKey to VerifyingKey and enhancing secp256k1 support, relating to improvements in the cryptographic framework.
• refactor(common): use underlying VK types instead of Vec<u8> #150: Refactors VerifyingKey implementation to use underlying types, aligning with updates to documentation regarding architecture.
• refactor: re-format files according to new rustfmt config #151: Formatting changes for code readability, relevant to the focus on enhancing documentation clarity and structure.

🐰 "In the garden of knowledge, we hop and play,
With diagrams replaced, in a clearer way.
New sections bloom, like flowers in spring,
Explaining Prism's magic, oh what joy they bring!
From podcasts to streams, we share and we learn,
In this world of trust, let our wisdom burn!" 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.