Repository navigation
Add new-page skill - #12192
Add new-page skill#12192dbreseman wants to merge 20 commits into
Conversation
| * In the front matter, complete `title`, `url`, and `description`, plus any other fields the page needs. Uncomment those fields, and delete the commented fields you don't use. | ||
| * Replace or remove every `{…}` placeholder and instruction comment. | ||
| * Delete optional sections that don't apply. | ||
| 7. Complete the introduction and the remaining sections. Content varies by content type. Add images only if the user provides them. Where an image is needed and none is available, leave out the `figure` shortcode and list the location in your final summary. |
There was a problem hiding this comment.
After this step, review files created vs input provided and give the user a summary of what was done. Flag if any input was omitted and why.
There was a problem hiding this comment.
Also search sibling files and flag to the user if anything might need updating in other files (labels, dates, etc) and if there are any conflicts. Prioritize technical accuracy, and if it isn't clear which version to trust, ask.
| If the user provides a link, read it only if you have a tool that can access it. If you can't access it, say so and ask the user to paste the content. | ||
| 2. Explore `content/en/docs/` and decide where the page belongs (if it isn't clear, ask the user to confirm). Read the section's `_index.md` and nearby pages to match their conventions. | ||
| 3. Search `content/en/docs/` for the page's main terms. Ignore the versioned folders for older Mendix versions (`refguide10`, `howto9`, and so on) unless the user says the page is for an older version. If a page already covers the entire topic, tell the user and ask whether to update that page instead. If a page covers part of it, link to that page instead of repeating the covered content, and ask the user whether the missing content belongs on the existing page or on the new one. Note any pages that need a link to the new page, and tell the user at the end. | ||
| 4. Read the appropriate template from `templates/`. |
There was a problem hiding this comment.
After this step, present a plan to the user for confirmation or adjustments. If there is missing or ambiguous information, ask for it.
There was a problem hiding this comment.
If no template fits, say so (and ask if you should generate based on the sibling style)
| 2. Explore `content/en/docs/` and decide where the page belongs (if it isn't clear, ask the user to confirm). Read the section's `_index.md` and nearby pages to match their conventions. | ||
| 3. Search `content/en/docs/` for the page's main terms. Ignore the versioned folders for older Mendix versions (`refguide10`, `howto9`, and so on) unless the user says the page is for an older version. If a page already covers the entire topic, tell the user and ask whether to update that page instead. If a page covers part of it, link to that page instead of repeating the covered content, and ask the user whether the missing content belongs on the existing page or on the new one. Note any pages that need a link to the new page, and tell the user at the end. | ||
| 4. Read the appropriate template from `templates/`. | ||
| 5. Create the new file based on the template. File names must be simple, lowercase, and hyphen-separated. |
There was a problem hiding this comment.
Adjust—not necessarily one new file (it's possible that several files are needed). Also check if a release note is needed.
| 7. Complete the introduction and the remaining sections. Content varies by content type. Add images only if the user provides them. Where an image is needed and none is available, leave out the `figure` shortcode and list the location in your final summary. | ||
| 8. Verify that any linked pages exist in the repo, using each target page's `url` front matter field. Link to the related pages found in step 3. | ||
| 9. Run the `docs-copyedit` and `docs-alt-text` skills on the new page. | ||
|
|
There was a problem hiding this comment.
Run docs-pr-review afterwards
| 8. Verify that any linked pages exist in the repo, using each target page's `url` front matter field. Link to the related pages found in step 3. | ||
| 9. Run the `docs-copyedit` and `docs-alt-text` skills on the new page. | ||
|
|
||
| Don't add product claims, technical behavior, or release facts that the user didn't provide. If more information is needed, ask the user to provide it. |
There was a problem hiding this comment.
Note to keep in mind during review: pay special attention to figures, tables, code blocks, etc. Are they used appropriately? Is it correctly interpreting where they belong?
No description provided.