-
Notifications
You must be signed in to change notification settings - Fork 532
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
docs: Move "API Documentation" sections in package READMEs from the autogenerated "footer" section to the "header" #21946
docs: Move "API Documentation" sections in package READMEs from the autogenerated "footer" section to the "header" #21946
Conversation
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As usual, trusting the new line numbers 😄
I've noticed this error comment on a few PRs. What's the issue here? Is this a built-in GitHub check that fails because of how we're using Hugo or something? Is there a way to fix it or else disable this error if it doesn't matter? |
Our redirect infra for the API docs doesn't play nicely with the link checker. We have some work filed to fix this. I believe scheduled this sprint on Team Sasha. |
⯅ @fluid-example/bundle-size-tests: +245 Bytes
Baseline commit: 63164b7 |
The general idea here is that the "header" describes mechanical aspects of installing / using the library. Where the "footer" enumerates relevant Fluid Framework policies. The API docs belong in the former category.