Skip to content

Conversation

@topiga
Copy link
Member

@topiga topiga commented Jan 30, 2025

Let's begin this journey to get the best information, guides, tips and tricks for the Ugreen NASync series.

Summary by Sourcery

Add contributing guidelines, instructions for setting up a development environment, and steps for submitting changes. Include details on forking and cloning the repository, installing necessary dependencies, and building the documentation locally.

New Features:

  • Add Home Assistant installation guide
  • Add Accessing BIOS guide

Documentation:

  • Add a contributing guide
  • Add a getting started guide

@topiga topiga added the content Improvements or additions to content label Jan 30, 2025
@topiga topiga self-assigned this Jan 30, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request introduces the basic structure and content for the Ugreen NASync community guide website. It includes the initial documentation, contribution guidelines, and a basic setup for the site using Vitepress.

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

File-Level Changes

Change Details Files
Initial website structure and content
  • Added a basic README.md file with a description of the project.
  • Created a guide on how to install Home Assistant using Docker Compose on UGREEN NAS.
  • Added a detailed contributing guide for the project.
  • Created a homepage for the website with a hero section and feature list.
  • Configured the Vitepress configuration file with navigation and sidebar settings.
  • Added a guide on how to access the BIOS of the Ugreen NASync device.
  • Created a bug report template for GitHub issues.
  • Added an introduction to the Ugreen NASync series.
  • Created a GitHub workflow for deploying the website to GitHub Pages.
  • Created a content request template for GitHub issues.
  • Created a feature request template for GitHub issues.
  • Added custom CSS for the website theme.
  • Created a pull request template for GitHub.
  • Added a basic contributing guide.
  • Added an introduction to the website itself.
  • Added package.json and package-lock.json for dependencies.
  • Added a theme index.js file.
  • Added a logo for the website.
README.md
docs/ugos/install/homeassistant.md
docs/contributing.md
docs/index.md
docs/.vitepress/config.js
docs/advanced-guides/accessing-bios.md
.github/ISSUE_TEMPLATE/bug_report.yml
docs/introduction/what-is-nasync.md
.github/workflows/deploy.yml
.github/ISSUE_TEMPLATE/content_request.yml
.github/ISSUE_TEMPLATE/feature_request.yml
docs/.vitepress/theme/custom.css
.github/pull_request_template.md
CONTRIBUTING.md
docs/introduction/what-is-this.md
package.json
docs/.vitepress/theme/index.js
docs/public/ug_community_guide_logo.svg
package-lock.json

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@topiga topiga merged commit 67fd904 into main Jan 30, 2025
1 check passed
@topiga topiga deleted the dev branch February 9, 2025 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Improvements or additions to content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants