Docsite search: selectively include job examples
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5
- Forks
- 10
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 17
Description
The docsite includes extensive libraries of example job code
Most of them are rubbish. Well that's not fair, most of them are just a bit old.
I'm pretty sure that we ignore them right now.
The services team is actively working on improving these and the most modern, updated examples are a great input for the assistant.
We should work out a) how to include them in the embedded docs (is this a new doc type?) and b) how to ignore the bad ones (maybe we embed a tag in the data which our docs parser can pick up)
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
No files or tests are named. Start by tracing the docsite's embedded-doc parser and how job examples are currently handled, then clarify inclusion criteria and the proposed tagging approach with the services team. Done means selected modern examples are searchable while excluded examples are not.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100