Enable Private Link Sharing for API Documentation Articles
under review
Vaishnave Jayaraman
Currently, Document360 allows private link sharing for articles in the Knowledge Base (KB), enabling teams to share unpublished or draft content via links for review. However, this capability does not extend to API Documentation, limiting collaboration and cross-functional review workflows.
For many organizations, particularly those operating in B2B SaaS or developer-focused environments, API documentation requires careful vetting and technical accuracy. A standard workflow involves sharing pre-published content with engineering teams for approval, especially when:
- Technical accuracy must be reviewed before release
- Multiple contributors (e.g., product managers, tech writers, engineers) are involved
Without private link functionality, teams must either:
-Publish prematurely to collect feedback
-Export manually and send static versions
Proposed Solution:
Extend the “Share via Private Link” capability to API Documentation, with parity to the existing KB feature. This would allow teams to:
- Generate secure, time-limited links to draft API documentation
- Share with internal or external stakeholders for feedback/approval
- Maintain a single source of truth with controlled access
- Avoid premature publishing while still enabling collaborative reviews
Benefits:
- Streamlined Content Review: Engineering, product, and CS teams can review and approve API docs in draft form.
- Improved Governance: Enables documentation gatekeeping before public release, critical for accuracy and compliance.
- Workflow Consistency: Brings KB and API Docs in sync from a process and tooling standpoint.
- Faster Iteration: Reduces back-and-forth and minimizes friction in the content development lifecycle.
Suggested Additions:
- Optional expiry date for the private link
- Link activity tracking (e.g., last viewed)
- Permissions: View only / Suggest edits
Log In
D
D360 Product Management
under review
Vaishnave Jayaraman
Adding Sangeeta to track the progress.