UI: Enhance Builder with in-line documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 2
Description
When available from the source ADM, the builder should display the description.
Fields should additionally display details on type information when available and links to applicable documentation. Linked documentation may eventually include links to the raw ADM, to a user-friendly HTML-formatted version of the ADMs (doesn't currently exist), to the relevant IETF type documentation (or a reference of the relevant piece pulled into a local help DB). Note: This ticket only covers linking to currently available information, additional issues may be appropriate for auto-generating improved user-friendly help files from the ADMs.
Some of these details may be hidden in a popup triggered by mouseover or an 'info' icon.
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 by locating the Builder UI and tracing how fields receive metadata from the source ADM. Review the available descriptions, type information, and documentation links, including raw ADM or IETF references, before deciding how inline details or an info popup should appear. Done means applicable available information is displayed without attempting to generate new help files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100