-
Notifications
You must be signed in to change notification settings - Fork 10k
[CF1] CF1 docs survey #22904
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
[CF1] CF1 docs survey #22904
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
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.
Other comments (6)
- src/content/docs/cloudflare-one/identity/idp-integration/index.mdx (8-8) The component is currently rendered at the very top of the page. If this is not intentional, consider moving it to a more appropriate location or adding conditional logic to control its visibility.
- src/content/docs/cloudflare-one/policies/browser-isolation/index.mdx (16-18) The informational note about plan availability has been moved below the introductory content. Consider whether it should remain at the top of the page to ensure users are immediately aware of plan requirements.
- src/content/docs/cloudflare-one/identity/index.mdx (8-8) The import statement now ends with a semicolon, which is inconsistent with the previous style. Consider removing the semicolon for consistency.
- src/content/docs/cloudflare-one/changelog/gateway.mdx (12-12) Consider adding a comment explaining the purpose of `` to improve maintainability and clarity for future contributors.
- src/content/docs/cloudflare-one/changelog/access.mdx (12-12) Consider adding a comment above the `` line to explain what this component does and what the 'survey' file contains. This will help future maintainers understand the intent behind this addition.
- src/content/docs/cloudflare-one/changelog/dlp.mdx (12-12) Consider adding a comment explaining the purpose of rendering the survey here, to provide context for future maintainers.
💡 To request another review, post a new comment with "/windsurf-review".
| import { DirectoryListing } from "~/components" | ||
| import { DirectoryListing, Render } from "~/components"; | ||
|
|
||
| <Render file="survey" /> |
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.
The component is added at the top of the page. Ensure this does not disrupt the main content flow or accessibility. If this is a temporary addition, consider adding a comment for future maintainers.
|
|
||
| import { Render } from "~/components"; | ||
|
|
||
| <Render file="survey" /> |
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.
The component is rendered at the very top of the page, before any introductory content. Please confirm that this placement is intentional and does not negatively impact the user experience. If the survey is not critical to see before the guide, consider moving it to the end or making its display conditional.
| import { Glossary } from "~/components" | ||
| import { Glossary, Render } from "~/components"; | ||
|
|
||
| <Render file="survey" /> |
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.
The addition of <Render file="survey" /> at the top of the page may be unclear to users. Consider adding a brief comment or section header to explain the purpose of the survey and why it appears here.
Summary
PCX-17405
Screenshots (optional)
Documentation checklist