Skip to content

Make documentation a first-class part of the product #32

@woutervroege

Description

@woutervroege

What a user wants to achieve

To understand how BlockNote works and how to extend it, with documentation that is clear, accurate, and closely aligned with the codebase.

Developers want documentation they can trust as they explore, build, and maintain features, without having to reverse-engineer behavior from source code alone.

What success looks like

  • Documentation reflects the current state of the codebase
  • Reference documentation stays accurate as APIs evolve
  • The codebase is easier to navigate with documentation as a guide
  • Developers can move between code and documentation seamlessly
  • Documentation supports both human understanding and AI-assisted workflows

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions