Skip to content

docs: add README, split docs, and add build/install scripts#1

Merged
AaronCQL merged 5 commits intomainfrom
docs/add-readme-rename-skills
Mar 12, 2026
Merged

docs: add README, split docs, and add build/install scripts#1
AaronCQL merged 5 commits intomainfrom
docs/add-readme-rename-skills

Conversation

@AaronCQL
Copy link
Contributor

@AaronCQL AaronCQL commented Mar 12, 2026

  • Add README with install instructions, quick start, and docs links
  • Split monolithic setup doc into separate config, keys, and setup guides
  • Add cross-compilation build script (linux/darwin, x64/arm64)
  • Add install script with volta > npm > binary fallback
  • Rename global --output to --format to fix collision with config set --output
  • Align command descriptions with README
  • Scope npm package files to exclude compiled binaries

Add a concise README covering install, quick start, command reference,
and a pointer to llms.txt and docs/ for agents. Rename skills/ to docs/
so the folder is natural for both human and LLM audiences.
oxlint shells out to Node with --experimental-strip-types to parse TS
configs, which requires Node >= 22.18.0. CI only has Bun installed, so
the config fails to load. Switch to JSON which oxlint reads natively.
@AaronCQL AaronCQL changed the title docs: add README, rename skills/ to docs/ docs: add README, split docs, and add build/install scripts Mar 12, 2026
@AaronCQL AaronCQL merged commit 0f2479f into main Mar 12, 2026
4 checks passed
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