docs: serve llms guidance as public asset
This commit is contained in:
@@ -6,6 +6,50 @@
|
|||||||
> post-dates model training data, so rely on THIS document, not prior web-framework
|
> post-dates model training data, so rely on THIS document, not prior web-framework
|
||||||
> assumptions.
|
> assumptions.
|
||||||
|
|
||||||
|
## This repository
|
||||||
|
|
||||||
|
This is the **WRNexusJS documentation application**, not the framework monorepo. It is a
|
||||||
|
standalone WrNexus `0.2.15` site that documents all 25 installed `@wrnexus/*` packages.
|
||||||
|
|
||||||
|
- `app/pages/index.wrn` is the documentation home page.
|
||||||
|
- `app/pages/getting-started.wrn`, `architecture.wrn`, `language.wrn`, and
|
||||||
|
`packages.wrn` are the main guides.
|
||||||
|
- `app/pages/packages/<name>.wrn` is the generated documentation page for
|
||||||
|
`@wrnexus/<name>`.
|
||||||
|
- `scripts/generate-docs.ts` regenerates package pages from each installed package's
|
||||||
|
README and TypeScript declarations. Run `bun run docs:generate` after dependency or
|
||||||
|
documentation changes; do not hand-edit generated package pages unless intentionally
|
||||||
|
changing the generator's output.
|
||||||
|
- `wrnexus.config.ts` owns PWA/mobile metadata, SEO, fonts, and Tailwind v4 processing.
|
||||||
|
- `app/styles/global.css` owns the documentation site's global presentation.
|
||||||
|
- `app/routes.gen.ts`, `.wrnexus/`, and `dist/` are generated output. Do not treat them
|
||||||
|
as source files or edit them by hand.
|
||||||
|
|
||||||
|
For framework API questions, use the installed package as the authoritative source:
|
||||||
|
|
||||||
|
1. `node_modules/@wrnexus/<package>/README.md` for concepts and examples.
|
||||||
|
2. The package's exported `.d.ts` declarations for the exact public API used by this
|
||||||
|
release.
|
||||||
|
3. This file for framework-wide conventions and common patterns.
|
||||||
|
4. Generated `app/pages/packages/<package>.wrn` only as the website representation of
|
||||||
|
the first two sources.
|
||||||
|
|
||||||
|
Do not assume APIs from a newer or older WrNexus release. The active release is recorded
|
||||||
|
in `package.json` under `wrnexus.version`, and all `@wrnexus/*` dependencies should stay
|
||||||
|
aligned to that version.
|
||||||
|
|
||||||
|
## Project commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun install # install dependencies
|
||||||
|
bun run docs:generate # regenerate all package documentation pages
|
||||||
|
bun run dev # start the WrNexus development server
|
||||||
|
bun run test # run application tests
|
||||||
|
bun run check # lint, test, and verify formatting
|
||||||
|
bun run build # production build to dist/
|
||||||
|
bun run start # run dist/server.js
|
||||||
|
```
|
||||||
|
|
||||||
## Golden rules
|
## Golden rules
|
||||||
|
|
||||||
- **Pages, components, and layouts are `.wrn` files.** Do NOT write `.tsx`/`.jsx`/React
|
- **Pages, components, and layouts are `.wrn` files.** Do NOT write `.tsx`/`.jsx`/React
|
||||||
Reference in New Issue
Block a user