docs: Adds a docusaurus documentation page for relic.

[SandPod]

Description

Adds a docusaurus documentation page and ci for automatic deployments and runs.

Not really sure why the ci fails when varifying build as this does not touch any other changes than the docs and workflows. But this PR can wait for #127

After this is deployed the temporary link to the documentation will be generated that needs to be updated in the configuration.

Related Issues

Related to: #39

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbit review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add-docusaurus-to-relic

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbit 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:
  • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbit or @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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.20%. Comparing base (8d5dbd9) to head (5486a60).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #132   +/-   ##
=======================================
  Coverage   84.20%   84.20%           
=======================================
  Files          83       83           
  Lines        2716     2716           
  Branches     1480     1480           
=======================================
  Hits         2287     2287           
  Misses        429      429           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[nielsenko]

It feels like a oddly high line count for an empty docs site 😄

[nielsenko]

The build failure is simply the dependency check that has spotted a newer version of a dependency that cannot be used with relic, given its current pubspec.yaml. This will prevent others from upgrading said dependency (cli_tools)

#127 fixes that.

[SandPod]

I agree that this is a crazy high line count. The package-lock.json is 17k lines... 🙃
There are probably some dependencies we could remove since we are not displaying any video so far, but we might as well keep it in if we expand the documentation.

[Tananga]

@SandPod @nielsenko Where can I find url to relic documentation? I would love to contribute but Im not able to find it anywhere

[Tananga]

OK I found it here https://github.com/serverpod/relic/tree/main/doc/site/docs

But maybe its a good idea to split is the same way as it is in Serverpod case? There is Serverpod and Serverpod Docs so Dart code dont mix with JavaScript docusaurus and you can keep 100% Dart in Relic Repo. I think that in the long term it will bring more benefits than mixing it all together

[SandPod]

@Tananga, The main benefit of having this in a shared repo is to ensure that new features are documented directly in the PR. Since this is a smaller project, we don't need to split these in separate repos.

You can also access the Relic documentation here: https://docs.dartrelic.dev

Although the documentation is still empty, we will add a link to this in the Readme.