Skip to content

Modernise documentation and enable agent-friendly output - #6

Merged
shayanhabibi merged 1 commit into
masterfrom
feature/docs-modernisation
Oct 7, 2026
Merged

shayanhabibi merged 1 commit into
masterfrom
feature/docs-modernisation

Conversation

@shayanhabibi

Copy link
Copy Markdown
Owner

Replace the duplicated long homepage with a responsive hero and focused guides for installation, inputs, execution, composition, Baked, and agent inspection. Preserve the existing page routes and detailed examples in Markdown references, with explicit sidebar groups.

Use Ranvier's published Partas.Nacara theme and AgentFriendly, Directives, and OgImage plugins. AgentFriendly now generates llms.txt, llms-full.txt, Markdown copies and alternate links; remove the old static index and duplicate post-build merge. Enable link validation after agent files are written.

Validation:

  • Build CLI docs command: 131 pages generated successfully; all local HTML links/assets and Markdown alternates verified.
  • Full Build CLI test run (test --quick): 558 suite tests and 22 Debug/Release compiler probes passed; 10 ignored tests.
  • F# samples from eight focused guides, the hero, and the composition file example compile in Release without executing workflows.
  • Desktop, mobile, light, and dark rendering inspected; independent review found no critical or important issues.

The existing FSharp.Compiler.Service exact-version restore warning remains. The published Partas.Nacara packages require FSharp.Core 11, confined to the documentation project; package versions and library targets are unchanged.

@shayanhabibi
shayanhabibi merged commit eeef772 into master Oct 7, 2026
5 checks passed
@shayanhabibi
shayanhabibi deleted the feature/docs-modernisation branch October 7, 2026 09:33
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