Repository navigation
fix(resources): render configured documentation sections #2532
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
6iu8a
wants to merge
1
commit into
graphql:source
Choose a base branch
from
6iu8a:fix/resource-docs-sections
base: source
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like it might be a band-aid -- @6iu8a I'm not too familiar with this section of the site, do you have any idea what the underlying problem might be? Should we be altering the
sectionslist instead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking a look! The underlying issue is that docs gets its content from a different source than the one this guard checks. sections already includes docs from categoriesConfig, and DocsSection resolves the configured doc paths through learnPages. Those pages aren't loaded into grouped, so the empty-resource check skips the section even though it has content.
I kept this change small to fix that mismatch, following the existing exception for event. Your suggestion about sections makes sense, though: we could determine which sections to display based on their respective data sources, then use that same list for both the TOC and rendering. Currently, the TOC uses the unfiltered list while the rendering loop can skip sections.
Would you prefer that I update this PR in that direction?