-
Notifications
You must be signed in to change notification settings - Fork 3
📝 Add development setup and ci-cd documentation #258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
🌐 Preview Deployment: https://docs-development-setup.gitdone.pages.dev |
WalkthroughAdds 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Comment |
There was a problem hiding this 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: /developmentdocs/.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
📒 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.
| :::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. | ||
| ::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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:
Getting Startedguide atdocs/src/development/index.mdto welcome new contributors and provide an overview of the development process.Development Environment Setupguide atdocs/src/development/setup.md, explaining how to set up Flutter for different platforms and prepare the project for local development.CI/CD Workflowsdocumentation atdocs/src/development/ci-cd.md, describing the main build and release pipeline and other automated workflows.Navigation Updates:
docs/.vitepress/config.tssidebar to include links to the newGetting Started,Local Setup, andCI/CD Workflowsdocumentation pages under the Development section, improving discoverability for contributors. [1] [2]