update instructions to add links
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: zensical-docs
|
||||
description: 'Reference skill for Zensical documentation mechanics. Use for quick lookup of docs structure, feature options, and source links, then edit this skill over time to record project preferences for when each feature should be used.'
|
||||
description: 'Reference skill for Zensical documentation mechanics. Use for quick lookup of docs structure, feature options, and source links. Prefer inline Markdown links to source docs and avoid bare URLs because this content is rendered as human docs and MCP resources.'
|
||||
argument-hint: 'What are you documenting, who is the audience, and what Zensical features are in scope?'
|
||||
x-personal-mcp:
|
||||
id: zensical-docs
|
||||
@@ -124,6 +124,30 @@ Keep this section short and revise it over time.
|
||||
|
||||
When making a recommendation, link back to the relevant reference file first, and when possible to the upstream docs linked from that reference.
|
||||
|
||||
## Link Formatting Rule
|
||||
|
||||
Because this project publishes the same markdown for both `/docs` and MCP resources, link quality is part of the content contract.
|
||||
|
||||
- Never leave a bare URL in prose or list items.
|
||||
- Prefer using in-place Markdown links with meaningful labels.
|
||||
- For external sources, prefer `[descriptive label](https://...)` over raw `https://...`.
|
||||
- For internal files, prefer relative Markdown links so rendered docs remain navigable.
|
||||
- Any mention of a library or a specific library feature should include a link to source documentation somewhere on the page.
|
||||
- If inline linking is awkward or the citation payload is too large, use a footnote or tooltip citation instead.
|
||||
|
||||
Example preferred style:
|
||||
|
||||
- `See [importlib.resources](https://docs.python.org/3/library/importlib.resources.html) for packaging details.`
|
||||
|
||||
Example to avoid:
|
||||
|
||||
- `See https://docs.python.org/3/library/importlib.resources.html for packaging details.`
|
||||
|
||||
Acceptable alternatives when inline links are not ideal:
|
||||
|
||||
- Add a footnote-style source citation at the end of the section or page.
|
||||
- Add a tooltip citation when the docs pattern supports it.
|
||||
|
||||
## Compatibility Rule
|
||||
|
||||
Prefer the Zensical-native way of doing something when it exists and is well-supported.
|
||||
@@ -136,3 +160,4 @@ Return only what is useful for the current docs task:
|
||||
1. Which reference to read next.
|
||||
2. The smallest recommended docs or config change.
|
||||
3. Any repo-specific preference this suggests should be added back into this skill.
|
||||
4. For any library or feature-level claim, include a source-doc citation somewhere (inline link preferred; footnote or tooltip acceptable).
|
||||
|
||||
Reference in New Issue
Block a user