feat: ✨ ♻️ 3.2.0 documentation update

[slugb0t]

Summary by Sourcery

Update the Codefair documentation to include new features and changes in the repository structure, such as the addition of a validation microservice and the transition to Prisma for database management. Revise the setup and running instructions, switching from pnpm to Yarn, and update environment variable configurations. Enhance the documentation with new sections, icons, and detailed instructions for improved clarity and user experience.

Documentation:

• Update documentation to reflect the new structure and components of the Codefair repository, including the addition of a validation microservice and the transition from MongoDB to Prisma for database management.
• Revise instructions for running the Codefair repository locally, including changes in prerequisites such as switching from pnpm to Yarn and updating environment variable configurations.
• Enhance documentation with new sections and icons for better clarity and user experience, including detailed steps for setting up and running different components of the repository.

[fairdataihub-bot]

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR updates the documentation for version 3.2.0, focusing on improving readability, updating environment variables, adding new sections, and modernizing the development setup. The changes include switching from pnpm to yarn, updating database requirements from MongoDB to Prisma, and adding documentation for the validation microservice.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Updated development environment setup and requirements	Switched package manager from pnpm to yarn Changed database requirement from MongoDB to Prisma ORM Added validation microservice setup instructions Updated environment variables for both UI and bot components Added detailed running instructions for all three components	docs/dev/running-locally.md
Enhanced metadata and license documentation	Added visual aids and improved section organization Added custom license handling documentation Improved instructions for metadata validation Updated OAuth authentication references Added rerun validation instructions	docs/docs/metadata.md docs/docs/license.md
Improved UI dashboard documentation	Added detailed event trigger explanations Enhanced repository action descriptions Added new validation rerun options Updated dashboard status information	docs/docs/ui-dashboard.md docs/docs/dashboard.md
Enhanced documentation readability and organization	Updated section headers with relevant emojis Improved formatting and structure Added clearer section divisions Enhanced visual hierarchy	docs/docs/cwl.md docs/docs/archive.md docs/docs/installation.md docs/docs/upcoming.md docs/docs/about.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
codefair-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 11:50pm

[fairdataihub-bot]

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

[sourcery-ai]

Hey @slugb0t - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[fairdataihub-bot]

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!