Skip to content

AW9 — Finalize release documentation, examples, known limitations, and user-facing claims #1285

Description

@joris97jansen

Description

Finalize release documentation for the static HTML/CSS engine.

This issue should produce the docs that explain what Borrowser can do, what it cannot do, how to run it, how to test it, how to debug it, and how to interpret limitations.

The goal is to make the release understandable and honest.

Requirements

  • Add release overview document.

  • Add “What this release supports” document.

  • Add “What this release does not support” document.

  • Add known limitations document.

  • Add getting-started instructions.

  • Add build/run instructions.

  • Add conformance test instructions.

  • Add compatibility corpus instructions.

  • Add debug snapshot guide.

  • Add architecture overview.

  • Add subsystem ownership overview.

  • Add examples:

    • simple static HTML/CSS page;

    • page with external stylesheet;

    • page with image;

    • responsive page;

    • form/focus example;

    • accessibility snapshot example;

    • compatibility report example.

  • Add public claim language.

  • Add FAQ:

    • Does Borrowser support JavaScript?

    • Is this a complete browser?

    • What does static HTML/CSS mean?

    • How are unsupported features handled?

    • How do I add a conformance fixture?

    • How do I report a compatibility issue?

  • Update README where appropriate.

  • Ensure docs link to feature tracker and release packet.

Exit Criteria

  • Release documentation is complete.

  • Known limitations are explicit.

  • User-facing claims are accurate.

  • Examples exist.

  • Test/debug instructions exist.

  • README and feature tracker are consistent.

  • The issue is closeable without changing engine behavior.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions