- Creating Documenation
- Documentation Lifecycle Management
Creating Documenation
Documentation Lifecycle Management
Manage your documentation site lifecycle including removal, self-hosting options, and account actions
Documentation Lifecycle Management
Understand how to manage your documentation throughout its complete lifecycle, from creation to removal, including self-hosting limitations and account management options.
Site Removal Flow
Managing and removing documentation sites follows a controlled process to ensure you maintain access to your content while keeping your account organized.
Export Your Content
Before removing a site, export your documentation content to preserve your work:
- Use the CLI command
docsalot pullto download all MDX files and assets - Save your
layout.jsonconfiguration for future reference - Export any custom styling or component configurations
Unpublish Your Documentation
Remove your site from public access:
- Navigate to your documentation dashboard
- Select the documentation you want to remove
- Click Settings → Danger Zone
- Choose Unpublish Site to take it offline immediately
Delete Documentation Project
Permanently remove the documentation from your account:
- After unpublishing, select Delete Documentation
- Confirm deletion by typing your documentation name
- This action is permanent and cannot be undone
Deleting a documentation site is permanent. Ensure you’ve exported all content before proceeding with deletion.
What Happens When You Remove a Site
When you remove a documentation site:
-
Immediate effects:
- The site becomes inaccessible at its public URL
- Custom domains are automatically unlinked
- Analytics data collection stops
- API access to the documentation is revoked
-
Data retention:
- Your content remains in your account for 30 days in case of accidental deletion
- After 30 days, all data is permanently removed
- Exported content remains in your local files
-
Billing implications:
- Removing a site stops any associated billing immediately
- Prorated refunds are available for annual plans
- Free tier sites can be removed without billing impact
Self-Hosting Limitations
Docsalot provides managed hosting with specific limitations regarding self-hosting options. Understanding these boundaries helps you plan your documentation strategy effectively.
What You Can Do
Export Content
Full access to download all your documentation content, including MDX files, assets, and configurations
Custom Domains
Connect your own domain to Docsalot-hosted documentation for branded URLs
Subdirectory Hosting
Deploy documentation to a subdirectory of your existing domain (e.g., yoursite.com/docs)
Version Control
Maintain your documentation in Git repositories with automatic deployment
What You Cannot Do
Self-Hosting Alternatives
If you need complete self-hosting control, consider these approaches:
Export and Convert
Hybrid Approach
- Export all content using the CLI
- Convert MDX files to standard Markdown
- Rebuild using an open-source documentation framework
- Host on your own infrastructure
Pros: Complete control over hosting and infrastructure
Cons: Loss of Docsalot features, manual maintenance required
Account Management Actions
Manage your Docsalot account and associated documentation projects with these administrative actions.
Account Settings
Access comprehensive account management options through your dashboard:
Profile Management
- Update email address and notification preferences
- Change password and enable two-factor authentication
- Manage API keys and access tokens
- Configure default settings for new documentation
Team Collaboration
- Invite team members to collaborate on documentation
- Set permissions and access levels
- Transfer documentation ownership between accounts
- Manage team billing and subscriptions
Billing and Plans
- View current plan and usage metrics
- Upgrade or downgrade subscription tiers
- Update payment methods
- Download invoices and billing history
Data Management
All data management actions comply with GDPR and privacy regulations. See our Privacy Policy for details.
Export All Account Data
Request a complete export of your account data:
- Navigate to Settings → Privacy & Data
- Click Request Data Export
- You’ll receive an email with a download link within 48 hours
- The export includes:
- All documentation content and configurations
- Account settings and preferences
- Analytics data (if applicable)
- Billing history
Delete Your Account
Account deletion is permanent and affects all documentation sites. Ensure you’ve exported necessary data before proceeding.
To permanently delete your account:
- Export all documentation you want to keep
- Cancel any active subscriptions
- Navigate to Settings → Danger Zone
- Click Delete Account
- Confirm by entering your email address
- Your account and all associated data will be permanently deleted
What happens after account deletion:
- All documentation sites are immediately taken offline
- Custom domains are released
- Team members lose access to shared documentation
- Data is queued for permanent deletion within 30 days
- You can create a new account with the same email after 90 days
Account Recovery
If you need to recover a recently deleted account or documentation:
Recovery is only possible within 30 days of deletion. After this period, data is permanently removed.
- Contact support at support@docsalot.dev within 30 days
- Provide your account email and verification details
- Support team will assist with recovery if data is still available
- Recovered accounts may need reconfiguration of custom domains and integrations
Best Practices
Regular Backups
Schedule regular exports of your documentation using the CLI to maintain local backups
Version Control
Keep your documentation in a Git repository for version history and collaboration
Documentation Archival
Before removing old documentation, archive it for future reference or compliance
Team Transitions
Transfer ownership before team members leave to maintain continuity
Frequently Asked Questions
Need Help?
If you need assistance with lifecycle management:
- Review our CLI documentation for export commands
- Check the API Reference for programmatic access
- Contact support at support@docsalot.dev
- Join our Discord community for help from other users