Skip to content

docs: update for Fable.Lit 2.0 - #91

Merged
JordanMarr merged 1 commit into
mainfrom
docs-2.0
Oct 27, 2026
Merged

JordanMarr merged 1 commit into
mainfrom
docs-2.0

Conversation

@JordanMarr

Copy link
Copy Markdown
Collaborator

Updates the docs and README for the 2.0 release (see #90).

Docs site

  • Getting started: Fable 5, Lit 3 (Lit 2 also works) and Elmish 5. Install with dotnet add package and npm install lit, with Femto as an option. Points to fable-lit-fullstack-template, and notes that Lit.TodoMVC was written for Fable 3.
  • Testing: a warning that Fable.Lit.Test isn't released for Fable 5 yet, because it's waiting on Fable.Expect.
  • Hot reloading: removes Snowpack. Notes that Elmish HMR hasn't been tested with Fable.Lit.Elmish 2.
  • Templates: drops the outdated claim that Lit.Elmish includes HMR, which was removed in 1.4.0.
  • nacara.config.json: the site URL, edit links and GitHub link now point at fable-hub.

README

  • NuGet badges, a link to the docs, and a status table for each package.
  • Explains that the docs toolchain needs Node 14.

Publish workflow

  • Deploys again on pushes to main that touch docsrc/ or nacara.config.json, and can still be run by hand.
  • Updated to current actions. Uses setup-dotnet with global.json, because npm install runs dotnet tool restore.
  • Stays on Node 14. Nacara 1.0 beta fails on Node 16+, because fs.rmdir(..., { recursive: true }) throws for missing folders there.

Tested locally: the site builds with Node 14 (npx -y node@14 node_modules/nacara/cli.js), and npm install succeeds on Node 14. The workflow itself hasn't run yet. It will run when this PR is merged, and deploy to gh-pages.

🤖 Generated with Claude Code

- Getting started: Fable 5, Lit 3 and Elmish 5; install with dotnet add package
  and npm; point to fable-lit-fullstack-template
- Note that Fable.Lit.Test isn't released for Fable 5 yet, and that Elmish HMR
  hasn't been tested with 2.0
- README: status of each package, link to #90 and the docs site
- Docs site config and links point at fable-hub/Fable.Lit
- Publish workflow: deploy docs on pushes to main again, on current actions

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@JordanMarr
JordanMarr merged commit bdc2865 into main Oct 27, 2026
2 checks passed
@JordanMarr
JordanMarr deleted the docs-2.0 branch October 27, 2026 15:03
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