tilt api docs are missing info for v1alpha1 types
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 10.1k
- Forks
- 413
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 6
Description
Expected Behavior
these docs show the fields' types
Current Behavior
the fields are described in the docs for the types' constructors (for example) but not the types
Context
I opened the api docs and cmd+f'd uitextinput and found docs that looked like they were what I wanted, but were missing the info I needed, and assumed the info I needed was just missing. (I didn't realize we had separate ctor and type docs)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API docs' Types section and compare its v1alpha1 entries with the linked constructor documentation, such as api.v1alpha1.ui_input_spec. Identify where the type documentation is generated or assembled. Done means the type pages include the fields' types, matching the information currently shown for their constructors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100