Skip to content
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

Addon-docs: Produce docs page entries in the index #18574

Merged
merged 6 commits into from
Jul 7, 2022

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Jun 26, 2022

Telescoping on #18573

Update Story Indexer to produce template and standalone docs entries, including template entries for the docs page feature.

Template (standalone: false) entries are needed for:

  • Docs Page
  • *.stories.mdx files that define a docs page and stories.

A Template entry expects to be rendered from and against a story file. (A standalone entry expects to be rendered as a MDX file)

Drop the legacy vs modern distinction -- a legacy entry is just a specific case of a template entry and they can be handled similarly in the preview.

This branch changes the sidebar, but the entries do not render in the preview (see #18595)

@nx-cloud
Copy link

nx-cloud bot commented Jun 26, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit efa1d76. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@tmeasday tmeasday changed the base branch from next to tom/sb-450-index-docspage-processing-configuration June 26, 2022 12:49
@tmeasday tmeasday requested a review from shilman June 26, 2022 12:49
@tmeasday tmeasday force-pushed the tom/sb-449-index-update-generation-to-produce branch 2 times, most recently from e35167e to d263a18 Compare June 29, 2022 11:12
@tmeasday tmeasday force-pushed the tom/sb-450-index-docspage-processing-configuration branch from ae3be2b to 1642483 Compare June 29, 2022 11:13
@tmeasday tmeasday force-pushed the tom/sb-449-index-update-generation-to-produce branch 2 times, most recently from 379b85b to 75b818a Compare June 29, 2022 11:15
@tmeasday tmeasday marked this pull request as ready for review June 29, 2022 11:19
@tmeasday
Copy link
Member Author

Note preview-side tests are failing on this branch, which is unsurprising

@tmeasday tmeasday force-pushed the tom/sb-450-index-docspage-processing-configuration branch from 1642483 to 814885f Compare July 1, 2022 02:07
@tmeasday tmeasday force-pushed the tom/sb-449-index-update-generation-to-produce branch from a682561 to 62153f3 Compare July 1, 2022 02:10
@shilman shilman changed the title Produce docs page entries in the index Addon-docs: Produce docs page entries in the index Jul 6, 2022
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with small sugestion

lib/core-server/src/utils/StoryIndexGenerator.ts Outdated Show resolved Hide resolved
@tmeasday tmeasday force-pushed the tom/sb-450-index-docspage-processing-configuration branch from ab17703 to c547333 Compare July 6, 2022 09:10
@tmeasday tmeasday force-pushed the tom/sb-449-index-update-generation-to-produce branch from 62153f3 to 70737e2 Compare July 6, 2022 09:12
@shilman
Copy link
Member

shilman commented Jul 7, 2022

@tmeasday bunch of failing tests. i guess these get fixed in a subsequent PR?

@tmeasday
Copy link
Member Author

tmeasday commented Jul 7, 2022

i guess these get fixed in a subsequent PR?

Yes, that's right.

@tmeasday tmeasday force-pushed the tom/sb-450-index-docspage-processing-configuration branch from c547333 to 45f141b Compare July 7, 2022 02:00
tmeasday added 4 commits July 7, 2022 12:02
Template (standalone: false) entries are needed for:
  - Docs Page
  - *.stories.mdx files that define a docs page and stories.

A Template entry expects to be rendered from and against a story file. (A standalone entry expects to be rendered as a MDX file)
@tmeasday tmeasday force-pushed the tom/sb-449-index-update-generation-to-produce branch from 70737e2 to 095a5a9 Compare July 7, 2022 02:04
Base automatically changed from tom/sb-450-index-docspage-processing-configuration to future/base July 7, 2022 23:38
@shilman shilman merged commit 060091b into future/base Jul 7, 2022
@shilman shilman deleted the tom/sb-449-index-update-generation-to-produce branch July 7, 2022 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants