Document OneDev Markdown entity reference syntax in companion skills #9
Service Desk opened 7 hours ago

Summary

Document OneDev Markdown linking syntax for issues, pull requests, and builds in the tod companion skills, so AI agents drafting comments/notes use the correct forms instead of GitHub-style bare #N (or incorrect cross-project forms).

Background

Raised from issue onedev/server#2910. Agents often need to reference issues/PRs/builds in Markdown. Numbers are independent per entity type, so bare #123 is treated as an issue reference. PR/build links need an explicit type prefix. Skills today mainly document CLI reference forms for tod arguments and only lightly mention Markdown forms (e.g. pr #<number> in a few workflows).

Scope

  1. Add a clear Markdown entity reference section to using-tod (or equivalent shared skill docs), covering at least:
    • Same project: issue #N, pr #N / pull request #N, build #N
    • Bare #N means issue (do not use bare #N when you mean a PR or build)
    • Cross-project by path: issue path/to/project#N, pr path/to/project#N, build path/to/project#N
    • Cross-project by key when the project has a key (e.g. issue OD-N, pr OD-N)
  2. Reinforce those forms in comment-drafting steps of work-on-issue, submit-issue-work, and any similar PR/issue workflows that author Markdown for OneDev.
  3. Keep CLI reference forms for tod arguments documented separately from Markdown linking, so agents do not conflate the two.

Out of scope

  • Default AI-user system-prompt append at workspace runtime (explicitly declined as the primary approach in the originating discussion)
  • Hard validation/linting of posted Markdown (possible future product work)

Acceptance

  • Companion skills document correct Markdown reference syntax with examples
  • Workflow skills that draft issue/PR comments point agents at those forms when mentioning issues, PRs, or builds
1/1
Type
Improvement
Priority
Normal
Assignee
Labels
No labels
Issue Votes (0)
Watchers (4)
Reference
TOD-9
Please wait...
Connection lost or session expired, reload to recover
Page is in error, reload to recover