miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(nx-dev): fix issue with related docs not loading (#31605)

Browse Source 
make sure new paths work for related docs resolution
include related docs for 'legacy' fallback page logic


## before: 
on the `/features/manage-releases` route
![WKMac
2025-06-16T15-37-13](https://github.com/user-attachments/assets/570493bb-571c-47fb-9dd8-dae6b138f951)

on the `/ci/features/affected` route
![WKMac
2025-06-16T15-37-53](https://github.com/user-attachments/assets/f269c6fe-01ec-43a4-a98a-37448d486a54)


## after:
on the `/features/manage-releases` route
![WKMac
2025-06-16T15-38-43](https://github.com/user-attachments/assets/98ed4e98-ea99-485b-b09e-82079bd88fdd)

on the `/ci/features/affected` route
![WKMac
2025-06-16T15-36-17](https://github.com/user-attachments/assets/31bf3be2-3104-4c3c-bdbf-c8701e99ce10)

rename recipes to guides for the related docs card
![WKMac
2025-06-16T16-01-05](https://github.com/user-attachments/assets/4fd6dcf9-dd02-4042-9102-b1d9e72e3866)
This commit is contained in:
Caleb Ukle 2025-06-16 12:03:28 -05:00 committed by GitHub
parent 87234da015
commit b97222ded4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
nx-dev/models-document/src/lib/related-documents.utils.ts
View File

@ -26,14 +26,15 @@ export function categorizeRelatedDocuments(
}, },
{ {
id: 'recipes', id: 'recipes',
name: 'Recipes', name: 'Guides',
matchers: ['/recipes/'], matchers: ['/recipes/', '/guides/'],
relatedDocuments: [], relatedDocuments: [],
}, },
{ {
id: 'reference', id: 'reference',
name: 'Reference', name: 'Reference',
matchers: ['/workspace/', '/nx-api/'], // TODO(caleb): including /technologies/ in the route will duplicate the display of `recipes/guides` so leaving off for now
matchers: ['/workspace/', '/nx-api/', '/core-api/'],
relatedDocuments: [], relatedDocuments: [],
}, },
{ {

3
nx-dev/nx-dev/pages/[...segments].tsx
View File

@ -288,6 +288,9 @@ export const getStaticProps: GetStaticProps = async ({
githubStarsCount: await fetchGithubStarCount(), githubStarsCount: await fetchGithubStarCount(),
}, },
menu, menu,
relatedDocuments: tagsApi
.getAssociatedItemsFromTags(document.tags)
.filter((item) => item.path !== '/' + params.segments.join('/')), // Remove currently displayed item
}, },
}; };
} catch (e) { } catch (e) {