search

azimuttapp / azimutt

Explore, document and optimize any database
https://azimutt.app
MIT License
1.36k stars 87 forks source link

Kickstart documentation #325

Closed loicknuchel closed 1 month ago

loicknuchel commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@loicknuchel has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 57 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 dd2fc348ad1f7d2b3b5b96afc7e7048a62b9327f and 9ac7817fb070dd9f29820c69fe8742918bd3f14d.

Walkthrough

The changes in this pull request introduce updates to the Azimutt web application, focusing on documentation organization and accessibility. A new module for structured documentation pages is added, along with methods to flatten this structure for easier access. Additionally, new routes and controller actions are created to serve documentation pages. Various HTML templates are modified to improve the user experience, including updates to existing documentation links and images, as well as restructuring the organization of partial templates.

Changes

File Path Change Summary
README.md Updated image source for Azimutt screenshot and changed AML documentation link to an external URL.
backend/config/config.exs Updated version and version date in configuration.
backend/lib/azimutt.ex Added doc_pages, doc_pages_flat, and flatten_pages methods for structured documentation organization.
backend/lib/azimutt_web/controllers/website_controller.ex Introduced docs/2 and doc/2 methods for rendering documentation templates.
backend/lib/azimutt_web/templates/website/aml.html.heex Updated script rendering path for modularity.
backend/lib/azimutt_web/templates/website/converters/convert.html.heex Updated dropdown filtering logic and template rendering paths for converters.
backend/lib/azimutt_web/templates/website/features/aml.html.heex Updated rendering paths for feature heading and screenshot partials to a new directory structure.
backend/lib/azimutt_web/templates/website/index.html.heex Enhanced security of external links by adding rel="noopener noreferrer" attributes.
backend/lib/azimutt_web/templates/website/use-cases/analyze.html.heex Added rel="noopener noreferrer" to external links for improved security.
backend/lib/azimutt_web/templates/website/use-cases/design.html.heex Updated links to use dynamic routes instead of static URLs for improved integration.
backend/lib/azimutt_web/views/website_view.ex Added new methods for rendering components with nested blocks.
cli/README.md Updated image source paths and adjusted HTML attributes for npm package link.
frontend/src/Services/Urls.elm Updated amlDocs string to a relative path for documentation.
libs/aml/README.md Updated image source paths and links for documentation to point to online resources.
backend/priv/static/blog/2022-09-01-changelog-2022-08/changelog-2022-08.md Updated documentation link for AML language.
backend/priv/static/blog/2022-10-17-azimutt-v2/azimutt-v2.md Enhanced description of Azimutt v2 release and updated documentation link.
backend/lib/azimutt_web/templates/layout/_website_navbar.html.heex Added new link to the documentation section in the website navigation bar.
backend/lib/azimutt_web/templates/sitemap/index.xml.eex Added new URL entry for the documentation page in the XML sitemap.
backend/lib/azimutt_web/templates/website/converters/_description-short.html.heex Updated rel attributes for links and changed migration guide URL to a dynamic path.
backend/lib/azimutt_web/templates/website/docs/create-your-project.html.heex Introduced new template for the "create your project" documentation page.
backend/lib/azimutt_web/templates/website/docs/installation.html.heex Introduced new template for installation documentation.
backend/lib/azimutt_web/templates/website/docs/what-is-azimutt.html.heex Introduced new template for the "What is Azimutt?" documentation page.

Poem

In the land of code where rabbits dwell,
New docs arise, oh what a swell!
With slugs and pages, all in a row,
A hop through knowledge, come join the flow!
Icons and links, a joyful sight,
Our warren of wisdom shines ever bright! 🐇✨

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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.