Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8d11a38
Add e2e showcase tests.
Vladyslav-Kuksiuk Jun 10, 2026
5371834
Add more descriptions.
Vladyslav-Kuksiuk Jun 10, 2026
f715042
Rearrange files.
Vladyslav-Kuksiuk Jun 10, 2026
ae38602
Fix paths.
Vladyslav-Kuksiuk Jun 10, 2026
c0db8e7
Add embedding README.
Vladyslav-Kuksiuk Jun 10, 2026
c321c61
Improve showcase embedding readme.
Vladyslav-Kuksiuk Jun 10, 2026
d483804
Remove redundant example.
Vladyslav-Kuksiuk Jun 10, 2026
3f0d78e
Improve readability.
Vladyslav-Kuksiuk Jun 10, 2026
4ee5be6
Improve comments filtering doc.
Vladyslav-Kuksiuk Jun 10, 2026
9d21add
Improve 'Instruction Tag' doc.
Vladyslav-Kuksiuk Jun 10, 2026
825644a
Improve 'Multi-Line Patterns' doc.
Vladyslav-Kuksiuk Jun 10, 2026
836517f
Improve 'Named Fragment' doc.
Vladyslav-Kuksiuk Jun 10, 2026
f3378e1
Improve all embedding docs.
Vladyslav-Kuksiuk Jun 10, 2026
24f5f2d
Improve showcase test.
Vladyslav-Kuksiuk Jun 10, 2026
4a19e6b
Add copyrights.
Vladyslav-Kuksiuk Jun 16, 2026
929de68
Remove `examples` folder from path.
Vladyslav-Kuksiuk Jun 16, 2026
c50e776
Add E2E tests to the CI.
Vladyslav-Kuksiuk Jun 16, 2026
eaf0f20
Improve links readability.
Vladyslav-Kuksiuk Jun 16, 2026
2eeef93
Fix tests under Windows.
Vladyslav-Kuksiuk Jun 16, 2026
9602d75
Improve readability.
Vladyslav-Kuksiuk Jun 17, 2026
4d34920
Merge remote-tracking branch 'refs/remotes/origin/master' into add-e2…
Vladyslav-Kuksiuk Jun 18, 2026
1739a57
Merge remote-tracking branch 'refs/remotes/origin/master' into add-e2…
Vladyslav-Kuksiuk Jun 18, 2026
a4830e8
Make docs more separated.
Vladyslav-Kuksiuk Jun 18, 2026
cbe1a3c
Fix merge issues.
Vladyslav-Kuksiuk Jun 18, 2026
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
12 changes: 6 additions & 6 deletions .agents/skills/review-docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name: review-docs
description: >
Reviews documentation changes in embed-code-go: Go doc comments, inline
comments, README.md, EMBEDDING.md, PROJECT.md, AGENTS.md, skills, Markdown
fixtures, and user-facing examples. Use when a diff touches prose,
comments, README.md, showcase guides, PROJECT.md, AGENTS.md, skills,
Markdown fixtures, and user-facing examples. Use when a diff touches prose,
documentation comments, embedding syntax docs, command examples,
architecture/package maps, or agent instructions. Read-only; does not run
builds unless explicitly asked.
Expand Down Expand Up @@ -61,10 +61,10 @@ and repository guidance. Do not duplicate `writer` for authoring strategy,
root, check mode, embed mode.
- **No orphans.** A paragraph, list item, or table cell must not end with a
final line containing only one word. Flag it and propose a reflow or rewrite.
- **Project docs keep their ownership.** `README.md` is user-facing,
`EMBEDDING.md` owns embedding syntax, `PROJECT.md` owns project description,
map, and compact doc pointers, skills own implementation details, and
`AGENTS.md` owns agent policy.
- **Project docs keep their ownership.** `README.md` is the short user-facing
entry point, showcase docs own complete usage details, `PROJECT.md` owns
project description, map, and compact doc pointers, skills own implementation
details, and `AGENTS.md` owns agent policy.

### C. Embedding-Specific Documentation

Expand Down
22 changes: 13 additions & 9 deletions .agents/skills/writer/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
name: writer
description: >
Writes, edits, and restructures embed-code-go documentation. Use when asked
to create or update README.md, EMBEDDING.md, PROJECT.md, AGENTS.md, skills,
Markdown fixtures, contributor notes, examples, command snippets, Go doc
comments, or inline explanatory comments. Verifies claims against current Go
code, tests, fixtures, and project flows.
to create or update README.md, showcase guides, PROJECT.md, AGENTS.md,
skills, Markdown fixtures, contributor notes, examples, command snippets,
Go doc comments, or inline explanatory comments. Verifies claims against
current Go code, tests, fixtures, and project flows.
---

# Write documentation
Expand All @@ -22,9 +22,13 @@ description: >

Prefer updating an existing document over creating a new one.

- `README.md`: user-facing overview, setup, configuration, modes, and flags.
- `EMBEDDING.md`: embedding syntax, source markers, patterns, fences,
separators, and comment modes.
- `README.md`: user-facing overview, short run/build instructions, and links
to the complete guide.
- `showcase/README.md`: complete user guide entry point and runnable workflow.
- `showcase/configuration/README.md`: command-line flags, YAML configuration,
source roots, include/exclude patterns, and multiple embedding targets.
- `showcase/embedding/README.md`: embedding instruction map; detailed syntax
belongs in the related `showcase/embedding/positive/*.md` feature page.
- `PROJECT.md`: project overview, project map, and compact doc pointers.
- `AGENTS.md`: agent operating policy and repository-wide rules.
- `.agents/skills/<name>/SKILL.md`: language, testing, writing, review, project
Expand All @@ -39,7 +43,7 @@ Prefer updating an existing document over creating a new one.
- For YAML configuration, check `cli/`, `configuration/`, and config fixtures
under `test/resources/config_files/`.
- For embedding syntax, check `embedding/parsing/`, `embedding/processor.go`,
`embedding/parsing/instruction.go`, and `EMBEDDING.md`.
`embedding/parsing/instruction.go`, and `showcase/embedding/`.
- For source fragments and patterns, check `fragmentation/`,
`embedding/parsing/pattern.go`, and relevant source fixtures.
- For comments modes, check `embedding/commentfilter/`.
Expand All @@ -60,7 +64,7 @@ Prefer updating an existing document over creating a new one.
code fence, fragment, source root, docs root, include pattern, exclude pattern.
- Do not leave orphans in prose: no paragraph, list item, or table cell should
end with a final line containing only one word. Reflow or rewrite the text.
- Do not duplicate long explanations between `README.md`, `EMBEDDING.md`, and
- Do not duplicate long explanations between `README.md`, the showcase, and
`AGENTS.md`; link to the owning document instead.

## Go Doc Comment Guidance
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@ jobs:
# Tests must be run sequentially because they create temporary files that can cause issues.
# Therefore, the "-p 1" argument is required.
run: go test -v ./... -p 1

- name: Run E2E Tests
run: go test -v -tags showcase ./showcase -p 1
Loading
Loading