Publishing documentation
Publishing Sylo docs for Security Review & AppExchange
This file maps repository sources to public URLs so you can complete Security Review requirement “stable public URLs” for data-flow and usage documentation.
Live site (Next.js app in website/)
Production deploy (e.g. Vercel) serves the same Markdown from docs/ at these paths on https://mysylo.ai (see website/app/resources/):
| Purpose | Public URL | Notes |
| :------ | :--------- | :---- |
| Documentation hub | https://mysylo.ai/resources | Index of all doc pages |
| Security & data handling | https://mysylo.ai/resources/security | Canonical page |
| Security (alias) | https://mysylo.ai/legal/sylo-security-and-data-handling | 308 → /resources/security |
| Admin / user guide | https://mysylo.ai/resources/admin-guide | Canonical page |
| Admin guide (alias) | https://mysylo.ai/docs/sylo-admin-guide | 308 → /resources/admin-guide |
| Feature list | https://mysylo.ai/resources/features | From APPEXCHANGE_FEATURE_LIST.md |
| Publishing checklist (this doc) | https://mysylo.ai/resources/documentation | From PUBLIC_DOCUMENTATION.md |
| Readiness checklist | https://mysylo.ai/resources/readiness | From APPEXCHANGE_READINESS.md |
| Privacy policy | https://mysylo.ai/resources/privacy | Use this URL in Listing Builder (privacy field) |
| Terms of use | https://mysylo.ai/resources/terms | Use this URL in Listing Builder (terms / legal field) |
| Support | https://mysylo.ai/support | Matches in-app supportUrl where configured |
Suggested URLs (custom domain or non-Next hosting)
If you host elsewhere, use HTTPS and keep paths stable. Typical choices:
| Purpose | Suggested path | Source in repo |
| :------ | :------------- | :------------- |
| Security & data handling | https://mysylo.ai/legal/sylo-security-and-data-handling | SECURITY_AND_DATA_HANDLING.md |
| Admin / user guide | https://mysylo.ai/docs/sylo-admin-guide | ADMIN_USER_GUIDE.md |
| Support | https://mysylo.ai/support | Support page + in-app links |
You may consolidate paths as long as URLs are stable and listed on the AppExchange submission.
What to do before launch
- Deploy — Ship the
website/app so/resources/*and redirects are live, or export Markdown to your CMS. - Verify — Links work without login; content matches the same major version you submit for review.
- Security Review wizard — Paste these URLs in the fields for documentation / data handling / usage.
- AppExchange listing — Add the same URLs in Listing Builder where Salesforce asks for documentation links.
- In-app Help — If the public guide differs from
https://mysylo.ai/support, sethelpUrlin each product’sLISTING_CONFIGto the admin guide URL (or a docs index).
Usage documentation alignment
- ADMIN_USER_GUIDE.md is the primary usage artifact for Rollups, Scheduler, Lookup, Base, uninstall, and test notes.
- In-app Help / Support should either point at these hosted pages or at a docs index that links to them (see APPEXCHANGE_READINESS.md).