tensorflow / tensorflow/tensorboard
Document plugins.
Open
Nobody has claimed this yet.
core:frontend
theme:ui-polish
theme:usability
type:docs
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 1
Description
Several important plugins today are undocumented. Each plugin should have a README.md page that contains
- An overview (the problem it solves + screenshots)
- Instructions on how to log information + sample code
- A section on features in the UI
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 identifying which plugins are undocumented and reviewing their existing code and UI entry points. For each selected plugin, create a README.md covering its purpose with screenshots, logging instructions with sample code, and UI features; done means every targeted plugin has that documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100