Skip to content

Publish api/v1.0 and repoint the API links away from ReadMe #141

Description

@allister-beamable

Carried forward from #127, which turned up two structural findings that are a publish decision rather than a copyediting task.

api/v1.0 has never been published. help.beamable.com/versions.json lists 20 Mike versions — WebSDK ×2, Unreal ×5, Unity ×4, Toolkit, Internal, Home, CLI ×6 — and no API-* among them. help.beamable.com/API-1.0/ is a 404. The branch takes AGENTS.md stamps, the site_url fix, sentence-case heading scope, and now a full copyediting pass, and none of it reaches a reader.

The home chooser still points the API card at ReadMe. docs/index.md:39,44 on home link to https://beam-api.readme.io/reference/how-to-authenticate (live, 200). unity/v6.0's docs/SUMMARY.md:8 carries the same external link as a top-level nav entry. So the one card that would make this lane discoverable routes readers to the platform being sunset, and the in-repo lane stays dark.

The two are one decision. Publishing without repointing leaves the lane undiscoverable; repointing without publishing breaks the links.

Blocked on #139 — the spec the reference page renders is a hand-dropped October 2025 snapshot, and publishing it as authoritative is hard to justify until it can be regenerated.

Also still open on #127 itself, and small enough to stay there: the theme = "dark" attribute on the OpenAPI widget pinning it dark regardless of Material's toggle, and the CID/PID wording mismatch between docs/includes/abbreviations.md and authenticating.md.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions