search

axone-protocol / docs

📜 Axone documentation portal (built with Docusaurus).
https://docs.axone.xyz/
BSD 3-Clause "New" or "Revised" License
40 stars 22 forks source link

Feat/academy introduction #404

Closed MdechampG closed 8 months ago

MdechampG commented 8 months ago

This PR aims at adding an introduction to the Academy overview. It lists the material that it is advised to read before delving into the academy.

Capture d’écran 2024-01-29 à 11 38 09 Capture d’écran 2024-01-29 à 11 38 26 Capture d’écran 2024-01-29 à 11 38 38

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

[!WARNING]

Rate Limit Exceeded

@MdechampG has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 39 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between f1d98649d5e3babe7336a99aa74a614c0058a08f and 73c38c8a59dcc3e1b88d325b2c84f20ca5736ca3.

Walkthrough

The recent updates bring significant improvements to the educational materials in the Academy documentation. The overview.mdx now features enhanced visual elements, a restructured content flow, and a more captivating introduction to the OKP4 protocol. The Academy's structure has been streamlined into two main parts: Fundamental Concepts and Technical Implementation, offering a more cohesive learning experience.

Changes

File Path Change Summary
docs/academy/overview.mdx Added image, new section on learning journey, rephrased introduction, restructured into Fundamental Concepts and Technical Implementation, refined language.
docs/whitepaper/introduction.md Fixed typo: "knowdledge" to "knowledge".

🐇✨
In docs and prose, we hop and tweak,
Fixing typos, making language sleek.
With images and structure, we refine,
To make learning a journey, utterly divine.
🌟📚

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
ccamel commented 8 months ago

@MdechampG The linter is complaining that the image file in use is actually a JPEG, despite the extension indicating it's a WEBP. 

$ file static/img/content/academy/overview-1.webp
static/img/content/academy/overview-1.webp: JPEG image data, Exif standard: [TIFF image data, big-endian, direntries=6, orientation=upper-left, xresolution=86, yresolution=94, resolutionunit=2], baseline, precision 8, 340x340, components 3
MdechampG commented 8 months ago

@MdechampG The linter is complaining that the image file in use is actually a JPEG, despite the extension indicating it's a WEBP.

$ file static/img/content/academy/overview-1.webp
static/img/content/academy/overview-1.webp: JPEG image data, Exif standard: [TIFF image data, big-endian, direntries=6, orientation=upper-left, xresolution=86, yresolution=94, resolutionunit=2], baseline, precision 8, 340x340, components 3

It should be good now 🤞🏻