Skip to content

Documentation for people and agents #13

Closed

Description

@n4ff4h
  • Docusaurus docs in docs/ (structure from package-skeleton) with docs/metadata.json
  • Every config option, public API documented with runnable examples
  • llms.txt at the root: rules for using the package, then an index of every page
  • AGENTS.md and CLAUDE.md (@AGENTS.md) for agents working on the repo

Activity

  1. added
    next-genNext-gen Javaabu packages
    docsDocumentation, llms.txt, Boost
    on Nov 4, 2026
  2. added a commit that references this issue on Nov 4, 2026
    2f8f494
  3. n4ff4h commented on Nov 4, 2026

    @n4ff4h
    CollaboratorAuthor

    Done on next-gen (2f8f494).

    • Docusaurus docs in docs/, with metadata.json, in the package-skeleton layout: intro, requirements, installation and setup, 15 basic-usage pages, 5 advanced-usage pages, API reference, migrating from Blade, upgrading from @javaabu/react-forms, parity, AI assistants, questions and security, changelog, about us, and contributing. Each page is task-oriented, with Blade and React side by side and runnable TSX.
    • llms.txt has the rules and an index of every page. src/docs.test.ts keeps the index, the relative links, the front matter and the API reference in sync with the code: every export must appear in docs/api-reference.md.
    • AGENTS.md describes the new layout and rules, and CLAUDE.md still contains @AGENTS.md.

    While writing the docs I found that Radix tabs unmount inactive panels, which would drop fields in other tabs from the submitted data. Every adapter now keeps tab panels mounted, there is a conformance case for it, and Javaabu/onu#60 asks for the same for accordions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation, llms.txt, Boostnext-genNext-gen Javaabu packages

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions