-
Notifications
You must be signed in to change notification settings - Fork 41
Refactor Default Automatable Values into reusable include file #1010
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: ahouseholder <[email protected]>
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.
Checked in local server, looks good.
@copilot Do you set the PR to Ready for review or is that something I need to do? |
I don't have the ability to change the PR status from draft to "Ready for review" - that's something you'll need to do. I can only make code changes, commit them, and push to the branch. |
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.
Pull Request Overview
This PR refactors the "Default Automatable Values" tip from a single location into a reusable include file, improving maintainability and discoverability across the documentation.
- Extracted the tip content into a reusable include file using mkdocs-include-markdown
- Replaced the original inline tip with an include statement in the bootstrap collection guide
- Added the tip to the Automatable decision point reference and gathering information pages
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
docs/_includes/default_automatable_values.md | New include file containing the extracted tip content |
docs/howto/bootstrap/collect.md | Replaced inline tip with include statement |
docs/reference/decision_points/automatable.md | Added the tip after the gathering information section |
docs/howto/gathering_info/automatable.md | Added the tip at the end of the page |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
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.
Long Live Co-pilot.
Overview
This PR refactors the "Default Automatable Values" tip from
docs/howto/bootstrap/collect.md
into a reusable include file, eliminating duplication and making the content available in multiple relevant locations throughout the documentation.Problem
The "Default Automatable Values" tip was only present in the bootstrap data collection guide, but this guidance is relevant in other contexts where users need to understand default values for the Automatable decision point.
Solution
Created a new include file
docs/_includes/default_automatable_values.md
containing the tip and used the mkdocs-include-markdown plugin to include it in three locations:docs/howto/bootstrap/collect.md
- Replaced the original inline tip with an include statementdocs/reference/decision_points/automatable.md
- Added after the "Gathering Information" tip to provide context on defaultsdocs/howto/gathering_info/automatable.md
- Added at the end to provide fallback guidance when information cannot be gatheredBenefits
Changes
docs/_includes/default_automatable_values.md
docs/howto/bootstrap/collect.md
to use includedocs/reference/decision_points/automatable.md
to include the tipdocs/howto/gathering_info/automatable.md
to include the tipFixes #962 (child issue of #522)
Original prompt
Fixes #962
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.