prompt: add documentation guidance for markdown anchor links#249
Open
blinkagent[bot] wants to merge 1 commit intomainfrom
Open
prompt: add documentation guidance for markdown anchor links#249blinkagent[bot] wants to merge 1 commit intomainfrom
blinkagent[bot] wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
<documentation>section to the system prompt with guidance for writing markdown docs:<a id="..."for anchor linksContext
This came up while working on coder/coder#21656 - I used an
<a id>tag to create a custom anchor, which wouldn't work with the docs renderer. Danny caught it in review.Most static site generators (including the one used for Coder docs) auto-generate anchors from headings, so raw HTML anchors are unnecessary and potentially unsupported.
Created on behalf of @bjornrobertsson