blueplum/apidoc
2
0
Fork 0
generated from musicparty/template
Code Issues 2 Pull Requests 1 Actions Packages Releases Wiki Activity

Document and freeze an early version spec for syntax #2

New Issue
Open
opened 2026-01-27 17:52:59 +00:00 by blueplum · 0 comments
blueplum commented 2026-01-27 17:52:59 +00:00
Owner
Copy Link

Loose goals:

  • Allow forwards-compatible versioning, e.g., @apidoc(2026) (similar to Rust editions)
  • Markdown inclusion
  • Some kind of namespacing and internal names (e.g., `User.Token` in the README.md)

Partial, if not entirety of the syntax used in README.md.

  • Decide
  • Document (wiki?)
  • Freeze
Loose goals: - Allow forwards-compatible versioning, e.g., `@apidoc(2026)` (similar to Rust editions) - Markdown inclusion - Some kind of namespacing and internal names (e.g., `` `User.Token` `` in the [`README.md`](/src/branch/main/README.md)) Partial, if not entirety of the syntax used in [`README.md`](/src/branch/main/README.md). - [x] Decide - [ ] Document (wiki?) - [ ] Freeze
blueplum added the
priority
high
infra
documentation
 labels 2026-01-27 17:52:59 +00:00
blueplum added the Z-specZ-syntax labels 2026-01-27 17:54:07 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
blocked
backend
Waiting for changes in the backend.
blocked
discussion
Waiting for details to be finalized
blocked
frontend
Waiting for changes in the frontend.
blocked
investigation
Cause of this issue is still unknown
closed
duplicate
This issue or pull request already exists
closed
tedious
This is too great of a change (split up the issue) or too low of a priority
closed
wontfix
This won't be fixed
discussion
Not yet planned / To discuss
 enhancement
New feature
 help wanted
Need some help
infra
backend
Issue pertaining to apidoc libraries
infra
documentation
Issue pertaining to documentation
infra
frontend
Issue pertaining to apidoc CLI or any of the shipped frontends
infra
integration
Issue where frontend and backend changes must align
priority
backlog
Non-priority at this moment, re-evaluate at a later stage of development
priority
critical
Should be fixed ASAP
priority
high
priority
low
priority
medium
T-bug
Something is not working
 T-correctness
This is a consequence of something else (not necessarily a bug) but isn't ideal
 T-performance
Issue relates to a performance bottleneck or otherwise issue
work
tedious
Problem is obscure, large in scope, or otherwise difficult to resolve
work
trivial
Problem is obvious and relatively quick to fix ("Good first issue")
Z-cli
Pertaining to the apidoc binary, and its CLI tools
 Z-spec
This relates to the shared implementation details of Apidoc
 Z-syntax
This relates to Apidoc syntax (and conversely, the parser)
No Label
infra
documentation
priority
high
 Z-spec Z-syntax
Milestone
No items
No Milestone
Assignees
Clear assignees
tommy tototomate123 blueplum
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: blueplum/apidoc#2
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?