Sharing Documentation

This guide covers how to publish your architecture documentation and share it with stakeholders, both inside and outside your organization.

Publishing Workflow

After generating documentation in a diagram view, you can publish it for sharing:

1. Navigate to your diagram view and open the Documentation tab
2. Generate or edit your documentation content
3. Select which workflows and deployments to include using the selection panels
4. Click Publish to create a shareable version
5. A unique URL is generated for the published documentation

Guest Access Tokens

Published documentation uses guest access tokens for secure sharing:

• Each published document gets a unique access token embedded in the URL
• Recipients can view the documentation without an Archflow account
• Tokens can be revoked to remove access
• Custom themes are automatically embedded in the token, so readers see your branded experience

Sharing the Link

Copy the published URL and share it via:

• Email to stakeholders
• Team chat channels (Slack, Teams, etc.)
• Meeting invitations or review agendas
• Internal wikis or documentation portals

What's Included in Published Documentation

Published documentation includes everything you've configured:

• Generated content --- All AI-generated and manually edited sections
• Workflows --- Business processes you selected for this view
• Deployments --- Infrastructure views you selected for this view
• Images --- Uploaded documentation images and diagrams
• Custom theme --- Your active theme colors and styling
• Table of contents --- Automatic navigation structure

Preview and Print

Before sharing, you can preview how published documentation will look:

• Preview --- View the documentation as recipients will see it
• Print view --- Optimized layout for printing or saving as PDF
• Responsive --- Documentation renders well on desktop, tablet, and mobile

Themes in Published Documentation

Your custom theme carries through to published documentation:

• Preset themes are applied automatically
• Custom TweakCN themes are embedded in the guest token
• Dark/light mode follows the reader's system preference
• All styling is self-contained --- no Archflow account needed to see the theme

Access Management

Manage access to published documentation:

• Republish --- Update the published content with your latest changes
• Unpublish --- Remove public access to the documentation
• Version tracking --- Published documentation is tied to your project version

Best Practices

• Publish after reviews --- Generate, review with your team, then publish
• Select relevant content --- Only include workflows and deployments that add value for the audience
• Use appropriate technical level --- Set the generation parameters to match your audience (executives vs. developers)
• Keep published docs current --- Republish when your architecture changes significantly
• Add images --- Upload architecture screenshots and diagrams to make documentation more visual

Next Steps