Created docs

[andersonresende]

Summary by Sourcery

Created documentation for the Next.js FastAPI Template using MkDocs Material, providing comprehensive guides for getting started, deployment, technology selection, and project contribution.

New Features:

• Added documentation site with multiple sections
• Implemented documentation generation using MkDocs Material

Documentation:

• Added comprehensive documentation using MkDocs Material
• Created multiple markdown files covering project setup, deployment, technology stack, and contribution guidelines
• Configured MkDocs with custom theming and metadata

Chores:

• Updated project version to 0.0.3
• Added documentation-related dependencies to requirements.txt

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces comprehensive documentation for the Next.js FastAPI Template, covering setup, deployment, contributing, and more. It also updates the project version to 0.0.3.

Flow Diagram for Contributing to the Project

flowchart LR
    A[Clone the repo] --> B{Install pre-commit hooks}
    B --> C{Update OpenAPI schema}
    C --> D{Run tests}
    D --> E{Documentation}
    E --> F{Release}

Loading

File-Level Changes

Change	Details	Files
Introduced comprehensive documentation for the Next.js FastAPI Template, including guides for getting started, additional settings, technology selection, and deployment.	Added a README with project overview, key features, and technology stack. Created a Get Started guide with setup and build instructions. Documented additional settings such as hot reload, testing, pre-commit setup, and database migrations. Provided a technology selection overview. Included a deployment guide with Vercel setup and CI/CD configuration. Added a contributing guide for local development and release process. Created a support guide with contact information. Configured mkdocs.yml for documentation generation. Added extra CSS for custom styling.	README.md fastapi_backend/requirements.txt docs/deployment.md docs/additional-settings.md docs/get-started.md mkdocs.yml docs/contributing.md docs/technology-selection.md overrides/main.html docs/support.md docs/stylesheets/extra.css docs/CHANGELOG.md docs/README.md docs/images/footer-logo.svg
Updated the project and documentation version to 0.0.3.	Incremented the version number in fastapi_backend/pyproject.toml. Incremented the version number in nextjs-frontend/package.json. Added a changelog entry for version 0.0.3 in CHANGELOG.md.	fastapi_backend/pyproject.toml nextjs-frontend/package.json CHANGELOG.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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

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.

[sourcery-ai]

Hey @andersonresende - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a brief description of the changes made in this pull request to improve clarity.
• The addition of documentation is great, but ensure that the links provided are working and lead to the correct sections.

Here's what I looked at during the review

• 🟡 General issues: 4 issues found
• 🟢 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.}