Creating an IndexStore for Quick Navigation
#889
Merged
Conversation
This file contains 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
Create `IndexStore`
fetch index data in `view/DocumentationTopic`
Get Quick Nav data from `IndexStore`
update items in `indexStore`
add `technologyUrl` prop
fix issues with accessing null items
move data fetching logic to `indexProvider.js`
add `errorFetching` to store
simplify index data path computation logic
add technology prop to store
add tests for `indexProvider`
|
@swift-ci test |
|
I've been checking the code and testing Quick Navigation and it's looking good to me! The only thing that I don't like in this current state is that we are duplicating the |
marinaaisa
reviewed
Aug 26, 2024
resets store before fetching new indexData
hqhhuang
changed the title
IndexStore for Quick NavigationIndexStore for Quick Navigation
mportiz08
reviewed
Sep 3, 2024
do not set `includedArchiveIdentifiers` in Navigator Provider
rename state to `indexState`
simplify logic to find technology index data
remove url related computed properties
move fetching logic to `view/DocumentationTopic`
display index data for correct language variant
save flattened data for all language variants to store
update flatChildren default format
make sure data defaults to swift variant & add tests
mportiz08
reviewed
Sep 10, 2024
rename and clean up node logic
mportiz08
approved these changes
Sep 11, 2024
Improve tests and test description
marinaaisa
reviewed
Sep 13, 2024
| expect(wrapper.find(QuickNavigationModal).props('children')).toEqual(swiftChildren); | ||
| }); | ||
|
|
||
| it('QuickNavigation falls back to swift items, if no objc items', async () => { |
There was a problem hiding this comment.
Why do we fallback to swift items? just curious about this
There was a problem hiding this comment.
See this issue, DocC defaults to swift when the archive is article only. If this issue is addressed, we can make the update here as well.
marinaaisa
approved these changes
Sep 13, 2024
This was referenced Sep 17, 2024
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Bug/issue #, if applicable: rdar://134272215
Summary
This PR creates a new
IndexStore. The eventual goal is to share this store between the navigator and Quick Navigation.But for this PR, only Quick Navigation will be getting data from the new store.
Additionally, the index data is fetched from the page view instead.
Moves
IncludedArchiveIdentifiersdata fromAppStoreto the newIndexStore.Testing
Manual testing, verify that Quick Nav still behaves as expected.
I've added some tests. I'm working on adding more.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded