Conversation
Summary of ChangesHello @66Bunz, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by introducing a robust and user-friendly system based on Material for MkDocs. It centralizes all project information, from administration guides to environment variable configurations and social authentication setups, into a single, navigable portal. The inclusion of an automated build and deployment process ensures that the documentation remains up-to-date and easily accessible, greatly improving the overall user and developer experience. Highlights
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive documentation site for the project using MkDocs, which is a great initiative. The documentation is well-structured and covers various aspects from administration to environment variables. My review focuses on improving consistency, fixing broken/outdated links that still point to the old wiki, and enhancing the overall user experience of the new documentation site. I've provided specific suggestions to address these points.
| 2. **Create a New User**: Use the following code to create a new user. Replace `new_username`, `new_password`, and `new_email` with the desired values. | ||
|
|
||
| ```python | ||
| User.objects.create_user(username='new_username', password='new_password', is_staff=True, is_superuser=True) |
There was a problem hiding this comment.
The documentation text on line 45 mentions new_email, but this code snippet for creating a new user doesn't include it. This could be confusing for users. To maintain consistency, please add the email parameter to the create_user call.
| User.objects.create_user(username='new_username', password='new_password', is_staff=True, is_superuser=True) | |
| User.objects.create_user(username='new_username', password='new_password', email='new_email', is_staff=True, is_superuser=True) |
| repo_name: FuzzyGrim/Yamtrack | ||
| repo_url: https://github.com/FuzzyGrim/Yamtrack | ||
| copyright: Copyright © 2022 - 2026 FuzzyGrim | ||
| edit_uri: edit/main/docs/ |
There was a problem hiding this comment.
To improve the structure and user experience of the documentation, consider explicitly defining the navigation structure using the nav key. This gives you control over the order and titles of the pages in the navigation. For example, you could add the following between copyright and edit_uri:
nav:
- 'Home': 'index.md'
- 'Administration': 'administration.md'
- 'Environment Variables': 'env-variables.md'
- 'Media Imports': 'media-imports.md'
- 'Social Authentication': 'social-auto.md'
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #1208 +/- ##
=======================================
Coverage 81.38% 81.38%
=======================================
Files 70 70
Lines 7258 7258
=======================================
Hits 5907 5907
Misses 1351 1351 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds a MkDocs (Material) documentation site to replace/augment the GitHub Wiki content, and introduces a GitHub Actions workflow to publish the docs to GitHub Pages.
Changes:
- Add
mkdocs.ymlconfiguration for Material for MkDocs with git metadata plugins and custom styling. - Add initial docs pages (index, env vars, media imports, social auth, administration) plus a logo asset.
- Add a GitHub Actions workflow to deploy the MkDocs site to
gh-pages.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
MkDocs Material configuration (theme, plugins, site metadata, extra CSS). |
docs/stylesheets/extra.css |
Custom theme color override. |
docs/social-auto.md |
Social authentication documentation page. |
docs/requirements.txt |
Python dependencies for building the docs site. |
docs/media-imports.md |
Media imports documentation page. |
docs/index.md |
Documentation homepage content (largely README-like). |
docs/env-variables.md |
Environment variables documentation page. |
docs/assets/logo.png |
Logo asset for the docs theme. |
docs/administration.md |
Administration / Django admin enablement guide. |
.github/workflows/build-docs.yml |
Workflow to build and deploy docs to GitHub Pages via mkdocs gh-deploy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| site_url: https://FuzzyGrim.github.io/Yamtrack/ | ||
| site_author: FuzzyGrim | ||
| site_description: >- | ||
| Yamtrack is a self hosted media tracker for movies, tv shows, | ||
| anime, manga, video games, books, comics, and board games. | ||
| repo_name: FuzzyGrim/Yamtrack | ||
| repo_url: https://github.com/FuzzyGrim/Yamtrack |
There was a problem hiding this comment.
The PR description/preview references 66bunz.github.io/Yamtrack, but mkdocs.yml hardcodes site_url, repo_url, and repo_name to FuzzyGrim/.... If this is being deployed from a different org/user repo, canonical URLs, edit links, and repository metadata in the generated site will be incorrect; please align these values (or update the PR description if FuzzyGrim is correct).
| name: build-docs | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| permissions: | ||
| contents: write | ||
| jobs: |
There was a problem hiding this comment.
This PR adds/modifies a workflow under .github/workflows/, but the existing App Tests workflow (.github/workflows/app-tests.yml) has a PR gate that fails the run whenever workflow files are changed. As-is, this will make CI fail for this PR and block merging unless that guard is adjusted or this workflow is introduced via a maintainer-only change path.
- Correctly rename `social-auth` from `social-auto` page - Fix links in documentation - Fix inline code formatting
This closes #1206
Preview: https://66bunz.github.io/Yamtrack/
This PR adds the documentation (copied from the current Wiki) using Material for MkDocs
Also the build workflow was added at build-docs.yml, the action was copied from the official documentation.
To deploy using GitHub Pages, from the settings of the repo > Pages > Source the
gh-pagesbranch needs to be selected.