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

improvement(api-markdown-documenter): Update default suite configuration to leverage new hierarchy options #23602

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Jan 17, 2025

The default suite structure has been updated as follows:
- Package and Namespace items now generate documents inside of their own folder hierarchy, yielding documents named "index".
- Enum and TypeAlias items now generate their own documents (rather than being rendered as sections under their parent document).

E.g., old output would likely look something like

- index.md
- package-a.md
- package-a/
    - foo.md
    - ...
- package-b.md
- package-b/
    - bar.md
    - ... 

And the new output would likely look more like:

- index.md
- package-a/
    - index.md
    - foo.md
    - ...
- package-b/
    - index.md
    - bar.md
    - ... 

Updates to the default-config test assets demonstrate the difference.

Also update the spase-config test suite to move the package documents under their own hierarchy to be more demonstrative of what an expected use case would likely look like. Other test cases have been updated to maintain existing behavior, accounting for the new defaults.

AB#24263

@github-actions github-actions bot added the base: main PRs targeted against main branch label Jan 17, 2025
@Josmithr Josmithr requested review from alexvy86 and a team January 17, 2025 20:12
@Josmithr Josmithr marked this pull request as ready for review January 17, 2025 20:12
@Copilot Copilot bot review requested due to automatic review settings January 17, 2025 20:12

Choose a reason for hiding this comment

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

Copilot reviewed 35 out of 51 changed files in this pull request and generated no comments.

Files not reviewed (16)
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/index.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/index.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testabstractclass-class.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testclass-class.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testemptyinterface-interface.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testenum-enum.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testinterface-interface.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testinterfaceextendingotherinterfaces-interface.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testinterfacewithindexsignature-interface.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testinterfacewithtypeparameter-interface.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testmappedtype-typealias.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testmodule-namespace/index.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testnamespace-namespace/index.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testnamespace-namespace/testclass-class.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testnamespace-namespace/testenum-enum.html: Language not supported
  • tools/api-markdown-documenter/src/test/snapshots/html/simple-suite-test/default-config/test-suite-a/testnamespace-namespace/testinterface-interface.html: Language not supported
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> [email protected] ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> [email protected] serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> [email protected] check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170508 links
    1603 destination URLs
    1842 URLs ignored
       0 warnings
       0 errors


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant