pallets-eco / pallets-eco/flask-debugtoolbar
Document 3rd party extensions
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 978
- Forks
- 151
- PR merge metrics
- No merged PRs in 30d
Description
There should be documentation on known 3rd party extensions, along with guidelines on contributing new ones. Docs should cover how to contribute new panels to the list, as well as some information on how to write a new panel.
There are a couple existing 3rd party add-on panels like:
https://pypi.python.org/pypi/Flask-DebugToolbar-Mongo
https://pypi.python.org/pypi/Flask-DebugToolbar-LineProfilerPanel
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
Review the existing documentation structure and the two linked third-party panels, Flask-DebugToolbar-Mongo and Flask-DebugToolbar-LineProfilerPanel. Document known extensions, explain how to contribute a new panel to the list, and describe how to write a panel; done means all three topics are covered with the existing examples as references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100