You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/export/docs.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -409,9 +409,14 @@ MIT. See [LICENSE](https://github.com/MrPunyapal/docsmith/blob/main/LICENSE) for
409
409
composer require --dev mrpunyapal/docsmith
410
410
```
411
411
412
-
## Install the AI agent skill
412
+
## Install the AI agent skills
413
413
414
-
Docsmith ships an [Agent Skills](https://agentskills.io) compatible skill called `docsmith-development`. It teaches coding agents such as Claude Code, Cursor, Codex, and OpenCode how to use the package: build options, frontmatter keys, versioned docs, docs hubs, and remote source syncing.
414
+
Docsmith ships two [Agent Skills](https://agentskills.io) compatible skills:
415
+
416
+
- `docsmith-development`: teaches agents the package itself, build options, frontmatter keys, versioned docs, docs hubs, remote source syncing, and Open Graph images.
417
+
- `docs-writing`: teaches agents how to write documentation pages that build cleanly and read well.
418
+
419
+
They work with coding agents such as Claude Code, Cursor, Codex, and OpenCode.
415
420
416
421
### Via Laravel Boost
417
422
@@ -435,7 +440,7 @@ Any agent supported by the [skills CLI](https://skills.sh) can install it too:
After installing, ask your agent to activate the `docsmith-development` skill when it works on documentation builds.
443
+
After installing, ask your agent to activate the `docsmith-development` skill when it works on documentation builds, and `docs-writing` when it writes or edits documentation pages.
439
444
440
445
## Build documentation
441
446
@@ -856,7 +861,7 @@ hidden: true
856
861
857
862
## LLM export
858
863
859
-
Docsmith generates three text files for LLM consumption: `llms.txt`, `llms-full.txt`, and `export/docs.md`. This is enabled by default; see [LLM Export](llm-export.md).
864
+
Docsmith generates three text files for LLM consumption: `llms.txt`, `llms-full.txt`, and `export/docs.md`. This is enabled by default; see [LLM Export](llm-export.md) for details.
860
865
861
866
## Attribution badge
862
867
@@ -894,6 +899,16 @@ If the source directory has no `index.md`, Docsmith generates a landing page aut
894
899
895
900
Every build also writes `search-index.json`, `sitemap.xml`, `.nojekyll`, and the LLM export files into the output directory.
896
901
902
+
## Linking between pages
903
+
904
+
Write internal links the GitHub way, pointing at the `.md` file:
905
+
906
+
```markdown
907
+
See [Versioned Docs](versioned-docs.md) for details.
908
+
```
909
+
910
+
Docsmith rewrites these to the built page URLs at build time. Relative paths (`../installation.md`) and fragments (`configuration.md#options`) both resolve, in plain builds as well as versioned and hub builds. Links to `.md` files that are not part of the build are left untouched, as are external URLs and anchors.
911
+
897
912
## README index compatibility mode
898
913
899
914
Docsmith can import README index formats used by projects like `laravel-undocumented` and `laravel-attributes-list`:
<h2id="install-the-ai-agent-skill">Install the AI agent skill</h2>
61
-
<p>Docsmith ships an <ahref="https://agentskills.io">Agent Skills</a> compatible skill called <code>docsmith-development</code>. It teaches coding agents such as Claude Code, Cursor, Codex, and OpenCode how to use the package: build options, frontmatter keys, versioned docs, docs hubs, and remote source syncing.</p>
60
+
<h2id="install-the-ai-agent-skills">Install the AI agent skills</h2>
61
+
<p>Docsmith ships two <ahref="https://agentskills.io">Agent Skills</a> compatible skills:</p>
62
+
<ul>
63
+
<li><code>docsmith-development</code>: teaches agents the package itself, build options, frontmatter keys, versioned docs, docs hubs, remote source syncing, and Open Graph images.</li>
64
+
<li><code>docs-writing</code>: teaches agents how to write documentation pages that build cleanly and read well.</li>
65
+
</ul>
66
+
<p>They work with coding agents such as Claude Code, Cursor, Codex, and OpenCode.</p>
62
67
<h3id="via-laravel-boost">Via Laravel Boost</h3>
63
68
<p>If your Laravel project uses <ahref="https://laravel.com/docs/boost">Boost</a>, the skill installs automatically because Docsmith is in your <code>composer.json</code>:</p>
<p>After installing, ask your agent to activate the <code>docsmith-development</code> skill when it works on documentation builds.</p>
78
+
<p>After installing, ask your agent to activate the <code>docsmith-development</code> skill when it works on documentation builds, and <code>docs-writing</code> when it writes or edits documentation pages.</p>
0 commit comments