Skip to content

prompt: add documentation guidance for markdown anchor links #249

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.

Sign up for GitHub

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

Open
blinkagent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

prompt: add documentation guidance for markdown anchor links #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/scout-agent/lib/prompt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,11 @@ Follow existing code style.
Add no comments unless asked.
After writing code, run tests/lint and iterate until production-ready.
If tests fail or are missing, **tell the User and ask how to proceed**.
</code-generation>`;
</code-generation>

<documentation>
When writing or editing markdown documentation:
- Do NOT use raw HTML tags like \`<a id="..."\` for anchor links. Most static site generators and documentation platforms auto-generate anchors from headings.
- Use standard markdown heading anchors (e.g., \`[link text](#heading-name)\`) which are auto-generated from heading text.
- Check the repository's existing docs for patterns before introducing new conventions.
</documentation>`;