docs: Adding Docs Guidelines to Contibuting Guidelines #1924
Conversation
Signed-off-by: Sandi Besen <[email protected]>
Summary of ChangesHello @sandijean90, 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 refines the documentation contribution process by introducing a detailed and structured set of guidelines within the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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 adds detailed documentation contribution guidelines to the CONTRIBUTING.md file. The changes are well-structured and comprehensive. I've provided a few suggestions to improve formatting consistency and align with the project's existing tooling, such as correcting heading levels, using the correct package manager command, and tidying up some minor formatting in the Markdown.
fixing heading markdown formatting Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Sandi Besen <[email protected]>
changing to pnpm instead of npm to be consistent Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Sandi Besen <[email protected]>
dosubot
bot
added
the
size:M
sandijean90
changed the title
sandijean90
force-pushed
the
DocsContributionGuide
branch
from
fbb45ba to
5d8e448
Compare
Signed-off-by: Sandi Besen <[email protected]>
dosubot
bot
added
size:S
|
@JanPokorny I made your suggested changes, please review |
CONTRIBUTING.md
Outdated
|
|
||
| ### 1. Process & PR Compliance | ||
| * **Documentation-First PRs:** Any change modifying existing features or introducing new functionality **must** include documentation updates within the same Pull Request. | ||
| * **Storage Location:** All new or updated documentation files must be located in the `docs/development` folder. The `docs/stable` is only to be updated if changes are urgent and can't wait until the next release. Reasoning for changes made to `docs/stable` must be explicitly called out in your PR description. |
There was a problem hiding this comment.
Lets clarify "Due to the nature of Mintlify, docs are deployed from the main branch, so we keep docs/stable frozen to correspond to the latest stable release."
CONTRIBUTING.md
Outdated
| * **Exemption Policy:** If a PR does not require documentation (e.g., internal refactoring, bug fixes with no API changes, or test updates), you must explicitly note this in your PR description: *"No documentation updates required."* | ||
|
|
||
| ### 2. Technical Validation & Automation | ||
| * **Clean Environment Test:** Every code snippet must be verified from a **fresh install** of Agent Stack in a clean virtual environment to ensure all dependencies are correctly accounted for. |
There was a problem hiding this comment.
I would suggest removing this. Wiping the environment is more of an internal standard for reviewing and testing PRs, not something we should expect contributors to do when developing.
CONTRIBUTING.md
Outdated
|
|
||
| ### Mintlify Preview for Live Changes | ||
| To verify the visual layout and formatting of your changes before submitting: | ||
| 1. **Prerequisites:** Ensure you have **Node.js version 19 or higher**. |
There was a problem hiding this comment.
Mise automatically handles dependencies
CONTRIBUTING.md
Outdated
| 1. **Prerequisites:** Ensure you have **Node.js version 19 or higher**. | ||
| 2. **Setup:** `cd` to the `docs` folder in the repo. | ||
| 3. **Installation:** Run `pnpm install`. As long as the folder has a `package.json`, this installs the same version of Mintlify used in the repository. | ||
| 4. **Execution:** Run `npx mintlify dev` to spin up a preview of the docs in your browser. Default is on port 3000: `http://localhost:3000`. |
There was a problem hiding this comment.
we standardize on mise here - mise docs:run
There was a problem hiding this comment.
pnpm and npx commands not necessary
Summary
Adding clearer documentation guidelines to the CONTRIBUTING.md file so contributors can have structured guidance as to what is expected from docs updates.
Documentation
If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.