-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs: update java sdk docs #4730
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?
docs: update java sdk docs #4730
Conversation
Formatting the documentation by adding accordion tags
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
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.
Greptile Overview
Greptile Summary
This PR restructures the Java SDK documentation to improve readability by wrapping installation methods, authentication methods, and operation sections (secrets, folders) in collapsible accordion components. The change reduces the effective page length from 18 full scrolls to 2-3 scrolls by allowing users to expand only relevant sections. Two duplicate "Authenticating" headings were removed to clean up the navigation structure. The documentation content itself remains unchanged - this is purely a formatting improvement using the existing AccordionGroup and Accordion components from the documentation framework (as seen in the GitHub SSO docs reference). The accordions follow the pattern used elsewhere in Infisical's documentation to organize lengthy technical content.
Important Files Changed
| Filename | Score | Overview |
|---|---|---|
| docs/sdks/languages/java.mdx | 4/5 | Wrapped installation, authentication, and operation sections in accordion components to improve navigation; removed duplicate "Authenticating" headings |
Confidence score: 4/5
- This PR is safe to merge with minimal risk as it only modifies documentation formatting without touching any production code or logic
- Score reflects minor documentation quality issues: redundant headings inside accordions (e.g., "### Maven" heading inside "Maven" accordion title) and inconsistent plural naming for folder operation accordions ("Create Folders" should be "Create Folder" to match singular operations)
- The java.mdx file should be reviewed for heading redundancy and naming consistency - consider removing H3 headings that duplicate accordion titles, and standardizing folder operation titles to singular form
Sequence Diagram
sequenceDiagram
participant User
participant "Documentation Site" as DocSite
participant "Java SDK Docs Page" as DocsPage
User->>DocSite: "Navigate to Java SDK documentation"
DocSite->>DocsPage: "Load java.mdx"
DocsPage->>User: "Render page with accordion components"
User->>DocsPage: "Click accordion to expand section"
DocsPage->>User: "Display expanded content (Installation/Auth/Secrets/Folders)"
User->>DocsPage: "Click accordion to collapse section"
DocsPage->>User: "Hide section content"
User->>DocsPage: "Scroll through page"
Note over User,DocsPage: "Page now requires only 2-3 full scrolls<br/>(reduced from 18 scrolls)"
1 file reviewed, 5 comments
Description 📣
Formatting the documentation by adding accordion tags
The Java SDK documentation was lengthy to read due to improper format for end users. (18 full page scrolls to read).
Added accordions to sections as required and deleted headings which were duplicated.
(2 headings to be exact, both
Authenticating)Now to the page only requires 2-3 full page scrolls to read it + users can skip sections they do not require.
P.S. : Please use hide white space feature while viewing diffs, and only a few lines are removed and all others are additions or whitespace updates.
Type ✨
Tests 🛠️
Ran it locally via mint dev, please note only screenshots of changed sections are attached.