a2ui-project / a2ui-project/a2ui

Create a `specification-change` skill

Open
#1,689 0 comments 0 reactions 0 assignees View on GitHub
P2
Dominant language
TypeScript
Stars
16.4k
Forks
1.3k
Avg merge
2d 13h
Merged PRs (30d)
134

Description

A skill to help with updating the specifications. It should explain:
- The different states specifications can be in e.g. draft, candidate, final etc.
- The types of changes that are allowed in each state
- How to create a new specification
- The writing style to use
- The set of files to consider e.g. both Markdown and JSON
- How to write and run the appropriate tests

Perhaps most of this is just regular documentation at `specification/docs` that is referenced by a skill. That way, it can also be discovered by humans easily.

The skill should specifically mention some things that need to be considered that are non-obvious including:
- Make sure you update the rules governing the structure of catalog documents, including the "allowed schemas" in `common-types.json` that can be referenced from component and function schemas.

This comes from @gspencergoog 's idea in https://github.com/a2ui-project/a2ui/pull/1629#discussion_r3424979613

Contributor guide

Open the contributing guide

Research direction

Look at the existing skills in the codebase to understand their structure and location. Review the specification documentation at `specification/docs` to understand the content that needs to be referenced. The skill should guide users through specification states, change types, and updating `common-types.json`. Test by creating and running the skill in the development environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, markdown, typescript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.