fj/docs/README.md
Stephen Way e60a810c69
Some checks are pending
ci / check (push) Waiting to run
docs: sync README + CLAUDE.md + architecture.md with recent additions
* README: new commands (milestone, search code, watch/star, edit-comment,
  request-review) and the `--json-fields` / `--no-pager` globals.
* CLAUDE.md: layout includes json_filter and .forgejo/workflows; test
  count updated to 75; HTTP retry, JSON projection, pager-on-Unix
  conventions documented; setup-git hostname-validation invariant
  called out; auth token TTY guard noted.
* docs/architecture.md: HTTP retry section now covers 429 / Retry-After
  and Request::try_clone; new JSON projection section explains the
  global --json-fields flow; test strategy mentions remote CI and
  ignored env-mutating tests.
* docs/README.md: link to SECURITY.md and CHANGELOG.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 14:57:07 -07:00

17 lines
820 B
Markdown

# `fj` documentation
- [`architecture.md`](architecture.md) — module graph, layering rules,
the HTTP funnel, pager + SIGINT, repo resolution, test strategy.
- [`jq.md`](jq.md) — the `fj api --jq` syntax. Dot paths, brackets,
negative indices, pipes.
- [`gh-to-fj.md`](gh-to-fj.md) — command-by-command mapping from gh.
- [`faq.md`](faq.md) — common questions about tokens, hosts, debug,
scripting, plugins.
- [`troubleshooting.md`](troubleshooting.md) — keychain prompts, hangs,
401 errors, `--debug`, pager opt-out, alias precedence, hook bypass.
For build/test workflow see [`../CONTRIBUTING.md`](../CONTRIBUTING.md).
For project conventions see [`../CLAUDE.md`](../CLAUDE.md).
For security policy see [`../SECURITY.md`](../SECURITY.md).
For release notes see [`../CHANGELOG.md`](../CHANGELOG.md).