-
Notifications
You must be signed in to change notification settings - Fork 4
docs: Documentation PDF upload debt #1146
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
base: main
Are you sure you want to change the base?
Conversation
PR SummaryThis pull request updates several documentation pages to clearly communicate that PDF uploads are treated as static documents. The changes introduce visually prominent callout boxes in various sections of the documentation (such as Document Overview, section statuses, collaboration, content block handling, test results, model editing, compliance assessments, and template management) to inform users that only documentation generated via the designated developer tool or created in the platform supports dynamic features such as editing, commenting, or linking artifacts. These modifications ensure that users are aware of system limitations regarding PDF uploads and help prevent confusion regarding available functionalities. The callouts serve to highlight that PDF uploads are immutable once uploaded and do not support dynamic updates or interactions. Overall, the changes improve clarity and guide the users on which document types support enhanced functionality. Test Suggestions
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: a392fda Modify the workflow to check a different depth:
|
Pull Request Description
What and why?
There was some missing verbiage in the docs surrounding conditions for PDF uploads for documentation. I've added this information in as a patch as this functionality has been out for quite a while.
How to test
Click on the links for the live previews and compare the changes in the screencaps.
What needs special review?
n/a
Dependencies, breaking changes, and deployment notes
n/a
Release notes
n/a
Checklist