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

refactor(api-markdown-documenter): Make configuration properties readonly #23368

Conversation

Josmithr
Copy link
Contributor

Makes a number of configuration properties readonly.

@Josmithr Josmithr requested review from alexvy86, a team and Copilot December 19, 2024 00:43
@github-actions github-actions bot added public api change Changes to a public API base: main PRs targeted against main branch labels Dec 19, 2024

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 12 changed files in this pull request and generated no comments.

Files not reviewed (7)
  • tools/api-markdown-documenter/src/documentation-domain-to-html/configuration/Transformation.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/renderers/html-renderer/Render.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/renderers/markdown-renderer/RenderContext.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/renderers/markdown-renderer/configuration/RenderOptions.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/api-item-transforms/configuration/TransformationOptions.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/api-item-transforms/configuration/Configuration.ts: Evaluated as low risk
  • tools/api-markdown-documenter/src/api-item-transforms/configuration/DocumentationSuiteOptions.ts: Evaluated as low risk
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 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"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

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

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170138 links
    1596 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors


@Josmithr Josmithr enabled auto-merge (squash) December 19, 2024 01:01
@Josmithr Josmithr merged commit 958a0d9 into microsoft:main Dec 19, 2024
31 checks passed
@Josmithr Josmithr deleted the api-markdown-documenter/make-properties-readonly branch December 19, 2024 01:08
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 public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants