feat: self-documenting docmap CLI + setup-guide skill#24
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR makes the @paleo/docmap CLI self-documenting (via --help, --guide, --search, and smarter default listing), and replaces the old docmap/workspace setup skills with a consolidated alignfirst-setup-guide skill to bootstrap or upgrade consumer repos.
Changes:
- Add
--help,--guide, and--searchto docmap; default to recursive listing for small doc sets (with short help preface). - Introduce
alignfirst-setup-guideskill with references + assets for docmap/workspace/AlignFirst setup and upgrades. - Update repository docs/READMEs and expand docmap test fixtures to cover “large tree” behavior.
Reviewed changes
Copilot reviewed 44 out of 49 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/docmap/SKILL.md | Removed legacy docmap authoring skill content (now provided by docmap CLI --guide). |
| skills/docmap/references/installation.md | Removed legacy installation reference (setup now lives under alignfirst-setup-guide). |
| skills/alignfirst-setup-guide/SKILL.md | New setup-time companion skill for installing/upgrading docmap/workspace/AlignFirst skills. |
| skills/alignfirst-setup-guide/references/workspace-setup.md | Convert to plain reference doc and fix relative links to new assets/ location. |
| skills/alignfirst-setup-guide/references/docmap-setup.md | New reference for installing docmap CLI + wiring docs discovery in instruction files. |
| skills/alignfirst-setup-guide/references/docmap-migrate-skills.md | Update migration instructions to match new docmap discovery wording. |
| skills/alignfirst-setup-guide/references/docmap-migrate-existing-docs.md | New reference for migrating an existing docs tree in place to docmap conventions. |
| skills/alignfirst-setup-guide/references/docmap-bootstrapping.md | New reference for bootstrapping docs by exploring the codebase. |
| skills/alignfirst-setup-guide/references/alignfirst-upgrade.md | Switch upgrade prerequisite from docfront to docmap; route to local reference docs. |
| skills/alignfirst-setup-guide/references/alignfirst-upgrade-from-v2.md | Replace docfront-based migration step with docmap migration reference. |
| skills/alignfirst-setup-guide/references/alignfirst-upgrade-from-v1.md | Replace docfront-based doc migration with docmap migration reference. |
| skills/alignfirst-setup-guide/references/alignfirst-skills-setup.md | New reference for configuring AlignFirst conventions and prompting skill install. |
| skills/alignfirst-setup-guide/assets/workspace.mjs | New reference wrapper script for @paleo/workspace worktree lifecycle. |
| skills/alignfirst-setup-guide/assets/workspace.md | New template end-user/agent documentation for workspace workflows. |
| skills/alignfirst-setup-guide/assets/dev-server.mjs | New reference wrapper script for @paleo/workspace dev-server management. |
| README.md | Update docmap section to point to --guide and new setup-guide skill. |
| packages/workspace/README.md | Replace references to workspace-guide with alignfirst-setup-guide. |
| packages/docmap/test/fixtures/large/only-subs/deep/leaf.md | Add large fixture content to validate “only subdirs” tip behavior. |
| packages/docmap/test/fixtures/large/nested-a/inner.md | Add nested fixture content for large-tree tests. |
| packages/docmap/test/fixtures/large/bulk/doc-20.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-19.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-18.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-17.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-16.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-15.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-14.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-13.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-12.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-11.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-10.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-09.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-08.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-07.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-06.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-05.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-04.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-03.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-02.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/fixtures/large/bulk/doc-01.md | Add bulk fixture doc for large-tree threshold tests. |
| packages/docmap/test/docmap.test.ts | Update tests for new default behavior and add coverage for help/guide/search/large-tree behavior. |
| packages/docmap/templates/guide.md | New CLI-shipped authoring guide template rendered by docmap --guide. |
| packages/docmap/src/formatter.ts | Add frontmatter search and fast file-counting helper for thresholded default recursion. |
| packages/docmap/src/cli.ts | Add new CLI modes (--help, --guide, --search) + small-tree recursive default and short-help preface. |
| packages/docmap/README.md | Update documentation to reflect self-documenting CLI and setup-guide-based bootstrapping/migrations. |
| packages/docmap/package.json | Ensure templates/ is published with the package. |
| docs/workspace-architecture.md | Update references from removed workspace-guide to new setup-guide blueprint. |
| docs/docmap-architecture.md | Document new CLI modes, shipped guide template, and small-tree default recursion behavior. |
| alignfirst-skills.md | Switch configuration/upgrade guidance to use alignfirst-setup-guide. |
| AGENTS.md | Update docmap discovery instructions to match new CLI behavior and wording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.