DefangLabs / DefangLabs/docs-chatbot
Ignore MD/highlighting in docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 14h 50m
- Merged PRs (30d)
- 21
Description
Docs contain stuff like
// highlight-start
and
// highlight-end
which mess up the regurgitated docs.
Contributor guide
No contributing guide indexed for this repository
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 file or test is named. Locate the code that regurgitates documentation and the tests covering Markdown or syntax highlighting, then reproduce the issue with highlight-start and highlight-end lines. Done means those markers no longer appear in the generated docs while surrounding content remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100