Skip to content

Conversation

@Friedinger
Copy link
Member

@Friedinger Friedinger commented Sep 20, 2025

This pull request adds new documentation pages and updates the navigation structure in the VitePress site to make it easier for developers to find setup instructions and CI/CD workflow details. The most important changes are the addition of guides for getting started, local environment setup, and CI/CD workflows, along with corresponding navigation updates.

Documentation Additions:

  • Added a new Getting Started guide at docs/src/development/index.md to welcome new contributors and provide an overview of the development process.
  • Added a detailed Development Environment Setup guide at docs/src/development/setup.md, explaining how to set up Flutter for different platforms and prepare the project for local development.
  • Added a comprehensive CI/CD Workflows documentation at docs/src/development/ci-cd.md, describing the main build and release pipeline and other automated workflows.

Navigation Updates:

  • Updated the docs/.vitepress/config.ts sidebar to include links to the new Getting Started, Local Setup, and CI/CD Workflows documentation pages under the Development section, improving discoverability for contributors. [1] [2]

@Friedinger Friedinger added 📝 Documentation Improvements or additions to documentation 🚀 Request Deploy Requests a deployment of the project labels Sep 20, 2025
@github-actions github-actions bot removed the 🚀 Request Deploy Requests a deployment of the project label Sep 20, 2025
@Friedinger Friedinger requested review from a team and java3east and removed request for a team September 20, 2025 18:04
@Friedinger Friedinger changed the title 📝 Add development setup documentation 📝 Add development setup and ci-cd documentation Sep 20, 2025
@Friedinger Friedinger added the 🚀 Request Deploy Requests a deployment of the project label Sep 20, 2025
@github-actions github-actions bot removed the 🚀 Request Deploy Requests a deployment of the project label Sep 20, 2025
@github-actions
Copy link

🌐 Preview Deployment: https://docs-development-setup.gitdone.pages.dev

@github-actions github-actions bot removed the 🚀 Request Deploy Requests a deployment of the project label Sep 21, 2025
@coderabbitai
Copy link

coderabbitai bot commented Sep 24, 2025

Walkthrough

Adds a Development docs hub with new pages for Getting Started, Local Setup, and CI/CD. Updates site navigation and sidebar to include these sections. Adjusts the docs landing page hero action to point to Development. No code or API changes; documentation-only additions and config updates.

Changes

Cohort / File(s) Summary
Navigation config
docs/.vitepress/config.ts
Inserts Development nav and sidebar entries: Getting Started (/development/), Local Setup (/development/setup), CI/CD Workflows (/development/ci-cd). No removals or reorders.
Development docs
docs/src/development/index.md, docs/src/development/setup.md, docs/src/development/ci-cd.md
Adds Development hub page, a detailed Flutter setup guide, and a CI/CD workflows guide outlining workflows, triggers, and artifacts.
Docs landing updates
docs/src/index.md
Changes second hero action from “Contributing” (/development/contributing) to “Development” (/development/).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, tap-tap: new trails to tread,
A burrow of docs where dev paths spread.
From setup burbles to CI/CD streams,
I hop through links, pursuing dreams.
Carrot-shaped nav, crisp and bright—
Merge, nibble, ship—by moonlight! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly states that the pull request adds documentation for development setup and CI/CD workflows, matching the main changes in the changeset. Although an emoji is included, the title remains concise and accurately summarizes the key additions.
Description Check ✅ Passed The description accurately outlines the documentation additions and navigation updates made in the pull request and aligns with the changeset, making it clearly related and sufficiently detailed for reviewers.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/development-setup

Comment @coderabbitai help to get the list of available commands and usage tips.

@Friedinger Friedinger merged commit 802540c into main Sep 24, 2025
11 of 12 checks passed
@Friedinger Friedinger deleted the docs/development-setup branch September 24, 2025 20:15
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (3)
docs/src/index.md (1)

16-17: Use canonical clean URL (no trailing slash) to match cleanUrls config.

Since cleanUrls is true in VitePress config, prefer /development to avoid redirects.

-          text: Development
-          link: /development/
+          text: Development
+          link: /development
docs/.vitepress/config.ts (1)

16-23: Normalize links to clean URLs (no trailing slash) for consistency and fewer redirects.

Align with cleanUrls: true; use /development instead of /development/.

-                        link: "/development/",
+                        link: "/development",
-                        link: "/development/",
+                        link: "/development",

Also applies to: 28-31, 55-61, 67-69

docs/src/development/ci-cd.md (1)

7-11: Link workflow file and ⚗️ Request Build label in docs for easier navigation

-The `test-build-release.yml` workflow is the central pipeline for building, testing, and releasing the application. It is triggered on key events such as pushes to main branches, pull requests, and releases.
+The `test-build-release.yml` workflow is the central pipeline for building, testing, and releasing the application (see the [workflow file](https://github.com/RubberDuckCrew/gitdone/blob/main/.github/workflows/test-build-release.yml)). It is triggered on key events such as pushes to main branches, pull requests, and releases.

-The build of the app is only triggered manually by adding the `⚗️ Request Build` label to a pull request.
+The build of the app is only triggered manually by adding the `⚗️ Request Build` label to a pull request (see the [⚗️ Request Build label](https://github.com/RubberDuckCrew/gitdone/labels/%E2%9A%97%EF%B8%8F%20Request%20Build)).
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e208761 and a173ac3.

📒 Files selected for processing (5)
  • docs/.vitepress/config.ts (2 hunks)
  • docs/src/development/ci-cd.md (1 hunks)
  • docs/src/development/index.md (1 hunks)
  • docs/src/development/setup.md (1 hunks)
  • docs/src/index.md (1 hunks)
🔇 Additional comments (1)
docs/src/development/index.md (1)

1-22: Nice Development hub page.

Clear pointers to setup, contributing, and CI/CD.

Comment on lines +85 to +87
:::warning
The NDK version must match the one specified in [`android/app/build.gradle`](https://github.com/RubberDuckCrew/gitdone/blob/main/android/app/build.gradle.kts#L14) because of native dependencies.
:::
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix admonition syntax (::: needs a space before the type).

:::warning and :::info won’t render as containers; must be ::: warning / ::: info.

-      :::warning
+      ::: warning
       The NDK version must match the one specified in [`android/app/build.gradle.kts`](https://github.com/RubberDuckCrew/gitdone/blob/main/android/app/build.gradle.kts#L14) because of native dependencies.
       :::
-:::info
+::: info
 Some issues may remain, such as missing Visual Studio or iOS tools. These can be ignored if you don't plan to develop for those platforms.
 :::

Also applies to: 110-112

🤖 Prompt for AI Agents
In docs/src/development/setup.md around lines 85-87 (and also apply the same
change at lines 110-112), the admonition syntax uses `:::warning`/`:::info`
without a space so the containers won't render; update each occurrence to
include a space after the colons (e.g., change `:::warning` to `::: warning` and
`:::info` to `::: info`) to conform to the markdown container syntax so the
admonitions render correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants