PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
categoryLinkSource does not accept none
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Documentation link
Describe the problem
The documentation indicates categoryLinkSource supports a none option, however, the plugin only accepts [tag, info, auto]
[ValidationError]: "config.api.sidebarOptions.categoryLinkSource" must be one of [tag, info, auto]
Suggested fix
Can we confirm if this functionality is no longer supported, and if so, remove this from the documentation?
If this option is no longer available, I would love to see this as a feature request. I am trying to remove category index page links from my sidebar and this would have been a huge help.
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 the linked README.md section around line 180 and trace the categoryLinkSource configuration validation that produces the reported error. Compare the documented options with the accepted values, then update the documentation or configuration behavior so they agree, with a check that the reported validation case is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100