cc74ad0bd0
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
- .woodpecker.yaml: image paths -> library/autojanet-{agent,dispatcher}
- .woodpecker.yaml: secret names RS_HARBOR_USER / RS_HARBOR_PASS (global)
- container/Dockerfile: restore COPY skills/, skills/ populated from opencode config
- skills/: 84 opencode skills bundled into image
- k8s/manifests: update image refs to library/
34 lines
1.9 KiB
Markdown
34 lines
1.9 KiB
Markdown
# Markdown Language Prompt Snippet
|
|
|
|
## Key Concepts
|
|
|
|
- **Heading Hierarchy**: `#` through `######` for document structure, with h1 as the title
|
|
- **Front Matter**: YAML metadata between `---` delimiters at the top of the file
|
|
- **Fenced Code Blocks**: Triple backticks with optional language identifier for syntax highlighting
|
|
- **Reference-Style Links**: `[text][ref]` with `[ref]: url` definitions, useful for repeated URLs
|
|
- **Tables**: Pipe-delimited columns with alignment markers (`:---`, `:---:`, `---:`)
|
|
- **Admonitions**: Blockquote-based callouts (`> **Note:**`, `> **Warning:**`) for emphasis
|
|
- **Task Lists**: `- [ ]` and `- [x]` for checklists in issue trackers and READMEs
|
|
- **HTML Embedding**: Raw HTML allowed inline for features Markdown does not support natively
|
|
|
|
## Notable File Patterns
|
|
|
|
- `README.md` — Project overview and entry point for new contributors (high-value)
|
|
- `CONTRIBUTING.md` — Contribution guidelines, code style, PR process
|
|
- `CHANGELOG.md` — Version history following Keep a Changelog or similar format
|
|
- `docs/**/*.md` — Documentation directory with guides, API references, tutorials
|
|
- `*.md` in source directories — Co-located documentation for modules or packages
|
|
- `ADR-*.md` or `adr/*.md` — Architecture Decision Records
|
|
|
|
## Edge Patterns
|
|
|
|
- Markdown files `documents` the code components they describe or reference
|
|
- Links to other `.md` files create `related` edges between documentation nodes
|
|
- Code block references mentioning file paths may imply `documents` edges to those files
|
|
- README files in subdirectories typically `documents` the module at that path
|
|
|
|
## Summary Style
|
|
|
|
> "Project overview documentation with N sections covering installation, usage, and API reference."
|
|
> "Architecture Decision Record documenting the choice of [technology] for [purpose]."
|
|
> "Contributing guide with code style rules, testing requirements, and pull request process."
|