Skip to content

Commit 74ed034

Browse files
committed
Update CLAUDE.md
1 parent f688045 commit 74ed034

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -632,6 +632,66 @@ Unreachable due to earlier validation:
632632
- `colorFailedToSet` - valid colors work; error path has stack cleanup issues
633633

634634

635+
## Documentation
636+
637+
Documentation is hosted in the wiki at
638+
<https://github.com/bwipp/postscriptbarcode/wiki>, and these pages are the
639+
source for the PDF and HTML documentation that is hosted at in GitHub Releases.
640+
641+
642+
### Wikidocs Submodule
643+
644+
The `wikidocs/` directory is a Git submodule that tracks the project's GitHub wiki repository.
645+
646+
The GitHub Actions workflow (`.github/workflows/ci.yml`) builds the
647+
documentation. Upon release (i.e. pushing a tag), the job uploads the build
648+
documentation to GitHub releases as `postscriptbarcode-manual.pdf` and
649+
`postscriptbarcode-manual.html`.
650+
651+
To regenerate the documentation locally:
652+
653+
```bash
654+
git -C wikidocs pull origin master
655+
git add wikidocs
656+
got commit -m "Bumped wikidocs"
657+
```
658+
659+
### Building Documentation
660+
661+
From the wikidocs directory:
662+
663+
```bash
664+
make -f __pandoc/Makefile all
665+
```
666+
667+
Outputs:
668+
- `__pandoc/barcodewriter.pdf` - Complete PDF manual
669+
- `__pandoc/barcodewriter.html` - Self-contained HTML documentation
670+
671+
The build requires Pandoc, the Haskell runtime and LaTeX.
672+
673+
674+
### Adding New Symbology / Options Documentation
675+
676+
When adding a new symbology page or options page, update the following files:
677+
678+
**Wiki content for symbologies** (in `wikidocs/` submodule):
679+
1. `symbologies/<Symbology-Name>.md` - Create the documentation page
680+
2. `symbologies/_Sidebar.md` - Add link in appropriate category section
681+
3. `symbologies/Symbologies-Reference.md` - Add entry with thumbnail image(s)
682+
4. `images/<name>.png` and `images/<name>.eps` - Example images (use `scale=1`)
683+
5. Related symbology pages - Add cross-references if applicable
684+
685+
**Wiki content for options** (in `wikidocs/` submodule):
686+
1. `options/<Option-Name>.md` - Create the documentation page
687+
2. `options/_Sidebar.md` - Add link in appropriate section
688+
3. `options/Options-Reference.md` - Add entry if applicable
689+
690+
**Build system**
691+
1. `wikidocs/__pandoc/Makefile` - Add to `REF_FILES` in appropriate category
692+
2. `.github/workflows/ci.yml` - Add to BOTH `docs-pdf` and `docs-html` jobs
693+
694+
635695
## PostScript Language paradigms
636696

637697
Pay attention to the direction of roll:

0 commit comments

Comments
 (0)