PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
None doesn't exist on `categoryLinkSource`
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Documentation link
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/README.md?plain=1#L182
Describe the problem
The option none doesn't exist on categoryLinkSource. I got this error:
message: '"config.orders.sidebarOptions.categoryLinkSource" must be one of [tag, info, auto]',
Suggested fix
Update the readme?
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 with README.md around line 182 and compare the documented categoryLinkSource values with the error message listing tag, info, and auto. Update the documentation so the option list matches the supported values, then verify the README no longer claims that none is available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100