Skip to content

docs: fix documentation issues and inconsistencies#89

Merged
jdx merged 4 commits into
mainfrom
fix-documentation-issues
Jan 17, 2026
Merged

docs: fix documentation issues and inconsistencies#89
jdx merged 4 commits into
mainfrom
fix-documentation-issues

Conversation

@jdx

@jdx jdx commented Jan 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fix typo "mutiple" -> "multiple" in README.md
  • Fix broken anchor link #shell_hook -> #shell-hook in getting-started.md
  • Replace TODO placeholders with proper documentation links
  • Update config.md with complete configuration options (depends, boot_start)
  • Fix cron link format and schedule format in config.md
  • Clarify HTTP ready check is not yet implemented in ready-checks.md
  • Fix README examples to use implemented ready check options (ready_delay, ready_output)
  • Fix field name typo in tests/README.md (retry_delay -> ready_delay)

Test plan

  • Verify documentation links work correctly
  • Verify configuration examples match actual code behavior

🤖 Generated with Claude Code


Note

Docs refresh and consistency fixes

  • Rewrites docs/architecture.md with a concise system overview, IPC protocol, lifecycle, and watchers (adds diagram)
  • Updates docs/config.md with current options (depends, boot_start, cron table) and clarifies ready_delay/ready_output
  • Cleans up docs/getting-started.md: fixes shell-hook anchor, adds links to config/boot-start, removes TODOs
  • Clarifies in docs/ready-checks.md that HTTP checks are not yet implemented
  • Fixes typos and examples in README.md ("multiple", ready check fields) and tests/README.md (field name)
  • Adds CLAUDE.md with build/lint/test commands and high-level architecture guidance
  • Adds docs/public/favicon.svg

Written by Cursor Bugbot for commit ff0d867. This will update automatically on new commits. Configure here.

jdx and others added 4 commits January 17, 2026 13:57
- Fix typo "mutiple" -> "multiple" in README.md
- Fix broken anchor link #shell_hook -> #shell-hook in getting-started.md
- Replace TODO placeholders with proper documentation links
- Update config.md with complete configuration options (depends, boot_start)
- Fix cron link format and schedule format in config.md
- Clarify HTTP ready check is not yet implemented in ready-checks.md
- Fix README examples to use implemented ready check options (ready_delay, ready_output)
- Fix field name typo in tests/README.md (retry_delay -> ready_delay)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add CLAUDE.md with build commands and architecture overview
- Add devil favicon SVG for docs site

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add ASCII architecture diagram showing system overview
- Replace verbose prose with tables for components, IPC protocol, states
- Condense 288 lines to 185 lines while preserving technical accuracy
- Remove "LLM-generated" disclaimer
- Add structured sections: Request Flow, Daemon Lifecycle, Background Watchers

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jdx jdx merged commit 54a7165 into main Jan 17, 2026
4 checks passed
@jdx jdx deleted the fix-documentation-issues branch January 17, 2026 20:09
@github-actions github-actions Bot mentioned this pull request Jan 18, 2026
jdx pushed a commit that referenced this pull request Jan 18, 2026
## 🤖 New release

* `pitchfork-cli`: 0.2.1 -> 0.3.0

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

## [0.3.0](v0.2.1...v0.3.0) -
2026-01-18

### Added

- *(web)* add devilish pitchfork theming to web UI
([#115](#115))
- *(web)* add web UI for daemon management
([#112](#112))
- show startup logs on successful daemon start
([#111](#111))
- add HTTP ready check for daemon startup
([#110](#110))
- delay autostopping daemons when leaving directory
([#108](#108))
- *(logs)* clear all logs when no daemon specified
([#109](#109))
- *(list)* show error messages in daemon list output
([#107](#107))
- refactor the code structure of `start` and `run`, allowing for
parallel starting daemons
([#56](#56))
- [**breaking**] support auto start on boot
([#53](#53))
- print logs when failed on `pf start|run`
([#52](#52))
- [**breaking**] support global system/user config
([#46](#46))
- *(test)* refactor tests and add tests for `interval_watch` and
`cron_watch` ([#45](#45))

### Fixed

- add timeouts to IPC operations to prevent shell hook hangs
([#106](#106))
- *(deps)* update rust crate toml to 0.9
([#50](#50))
- replace panics with proper error handling
([#90](#90))
- *(deps)* update rust crate notify to v8
([#78](#78))
- *(deps)* update rust crate duct to v1
([#72](#72))
- *(deps)* update rust crate dirs to v6
([#64](#64))
- *(deps)* update rust crate cron to 0.15
([#48](#48))
- *(deps)* update rust crate sysinfo to 0.37
([#49](#49))
- *(deps)* update rust crate itertools to 0.14
([#33](#33))
- *(deps)* update rust crate strum to 0.27
([#35](#35))
- *(deps)* update rust crate console to 0.16
([#32](#32))
- give a user-friendly error when the work fails
([#44](#44))

### Other

- *(cli)* add long_about with examples to CLI commands
([#91](#91))
- fix documentation issues and inconsistencies
([#89](#89))
- *(deps)* lock file maintenance
([#88](#88))
- *(deps)* update rust crate serde_json to v1.0.149
([#87](#87))
- *(deps)* lock file maintenance
([#85](#85))
- *(deps)* update rust crate serde_json to v1.0.148
([#84](#84))
- *(deps)* update rust crate tempfile to v3.24.0
([#82](#82))
- *(deps)* update rust crate rmp-serde to v1.3.1
([#80](#80))
- *(deps)* update rust crate serde_json to v1.0.147
([#81](#81))
- *(deps)* lock file maintenance
([#79](#79))
- *(deps)* update rust crate shell-words to v1.1.1
([#77](#77))
- *(deps)* lock file maintenance
([#76](#76))
- *(deps)* update rust crate log to v0.4.29
([#75](#75))
- *(deps)* lock file maintenance
([#73](#73))
- *(deps)* lock file maintenance
([#68](#68))
- *(deps)* lock file maintenance
([#65](#65))
- *(deps)* lock file maintenance
([#62](#62))
- *(deps)* update rust crate clap to v4.5.51
([#60](#60))
- *(deps)* lock file maintenance
([#59](#59))
- *(deps)* update rust crate clap to v4.5.50
([#57](#57))
- Update README ([#55](#55))
- *(deps)* lock file maintenance
([#54](#54))
- *(deps)* lock file maintenance
([#47](#47))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@jdx jdx mentioned this pull request Jan 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant