Skip to content

docs: image README, crow-nest as the documented default - #307

Merged
nibor1896 merged 4 commits into
mainfrom
readme-2026-09-25
Sep 25, 2026
Merged

nibor1896 merged 4 commits into
mainfrom
readme-2026-09-25

Conversation

@nibor1896

Copy link
Copy Markdown
Owner

Summary

Docs only, no code change.

  • README.md is one generated image (dark = crow theme, light = GitHub light, switched by <picture> / prefers-color-scheme), then the install lines, the docs sections as links, the licence line and a local Ko-fi button. Generator: tools/readme_image.py.
  • The old front-page sections moved to docs/user-guide/overview.md; the v2.7.0 page is archived as docs/archive/README-v2.7.0.md; the three screenshots moved into window.md, remote-models.md (and goals-and-subagents.md, already there).
  • crow-nest (Rust, port 8099) is the Default operating point in docs/operating-points.md, install.md, linux.md and the final screen of install.sh / install.ps1 (printed, not run); llama.cpp is Second. DEFAULT_BASE_URL unchanged.
  • Licence line corrected: Qwen3.8-Flash-Next is qwen-community-1.0; Unsloth only for the GGUF line.

Checks

check_operating_point.py 10/10, install.sh --selftest PASS, core 1529 OK, test_run_server_block PASS. All README links resolve.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LyBV1tX2JWocGLTjFkNYMh

nibor1896 and others added 4 commits September 25, 2026 23:18
README.md is one generated image (docs/images/readme/crow-dark.svg in the
window's crow theme for GitHub dark, crow-light.svg for GitHub light,
switched by <picture> and prefers-color-scheme), then the two install lines
as copyable code, the docs sections as links, the licence line and a Ko-fi
button kept as a local SVG instead of a shields.io badge.

tools/readme_image.py draws both images with GitHub's own font stacks and
reads the version pill from cli/crow.py. Every figure in it is dated.

Start, How to use, Features, Tools and Licence moved to
docs/user-guide/overview.md; the v2.7.0 page is archived whole as
docs/archive/README-v2.7.0.md. The three README screenshots now sit in
window.md, remote-models.md and goals-and-subagents.md. The licence line is
corrected: Qwen3.8-Flash-Next is qwen-community-1.0, Unsloth quantised only
the GGUF of the llama.cpp line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LyBV1tX2JWocGLTjFkNYMh
…output

The operating-point tables in docs/operating-points.md name crow-nest
(CNQ4.5-M NVFP4, port 8099) as Default on Windows and Linux; the
Flash-Next GGUF on llama.cpp becomes Second, the 27B Third. install.md and
linux.md lead with the crow-nest steps: clone, the container from Hugging
Face, cargo build, `cd ~/Projects/crow-nest && tools/serve-linux.sh --port
8099`, and the window with --base-url http://127.0.0.1:8099/v1.

install.sh and install.ps1 print the same crow-nest block first on their
final screen and the llama.cpp steps under "Second"; they run none of it.
The ps1 block names no llama-server so check_operating_point's anchor and
the selftest's client order (terminal line before window line) hold.

No code default changes: DEFAULT_BASE_URL stays 8083, said so in the docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LyBV1tX2JWocGLTjFkNYMh
… glyph gaps declared

- test_crow_gui: node colours console.log output when FORCE_COLOR is set in
  the caller's environment ('\x1b[33m1\x1b[39m' != '1'); the node helper
  drops FORCE_COLOR.
- test_crow_core AWriteParsesWhatItWroteTests: a cold node on a CI runner
  took past the 5 s syntax clock (push run of PR #307, main's b3c5574);
  these cases patch SYNTAX_CHECK_SECONDS to 60, the clock case mocks.
- check_gui_prereqs: point (ii) was red on 13 codepoints neither shipped
  Google Sans Code face covers; declared in KNOWN_UNCOVERED with the reason
  (web-view fallback face, or data never drawn). The stale-entry rule stays.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LyBV1tX2JWocGLTjFkNYMh
…n tests, glyph gaps declared"

This reverts commit 30c8398.
@nibor1896
nibor1896 merged commit 4664c3a into main Sep 25, 2026
4 checks passed
@nibor1896
nibor1896 deleted the readme-2026-09-25 branch September 25, 2026 21:34
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