Public Static Preview Boundary
Purpose
This document defines the boundary between the private technical documentation repository and the public-safe static documentation preview generated from it.
The repository may remain private, but the Vercel-rendered documentation site is public if its URL is shared on a GitHub profile, CV, application or portfolio page.
The purpose is to avoid confusing private repository storage with public documentation previewing.
Scope
This boundary applies to:
- Vercel static deployments generated from this repository
- documentation pages linked from GitHub profile material
- portfolio-safe documentation previews
- technical narratives that can be shown to recruiters or interviewers
- sanitized troubleshooting and validation notes
This boundary does not make the full repository public and does not authorize publishing private evidence, customer material, tokens, recovery codes or raw operational logs.
Public/private boundary
The static Vercel site is a public-safe preview layer.
It may contain:
- portfolio narrative
- documentation method descriptions
- sanitized case studies
- public-safe troubleshooting summaries
- quality gate explanations
- public/private boundary rules
- non-sensitive validation outcomes
It must not contain:
- actual API keys
- Vercel recovery codes
- payment details
- private customer evidence
- credential identifiers
- production domain names from customer environments
- confidential incident records
- unredacted screenshots containing secrets
- personal secrets or private operational notes
Correct wording
Use wording such as:
Public-safe documentation preview generated from a private technical documentation hub.
or:
Documentation method hub and portfolio documentation index.
Avoid wording that suggests the public Vercel site contains the whole private repository.
What this is not
This is not:
- a public mirror of the private repository
- a customer evidence archive
- a production documentation portal
- a secrets storage location
- a certification claim
- an enterprise documentation platform
It is a lightweight public-safe preview of selected documentation pages.
Deployment boundary
The static preview build intentionally uses a minimal generator instead of a full documentation framework.
This is deliberate:
right control, right layer, right weight
The preview proves that documentation can be rendered and navigated, but it does not turn the repository into a production documentation platform.
Link usage rule
When linking from a public GitHub profile or portfolio, prefer the stable production deployment URL instead of a deployment-specific preview URL.
Correct:
https://technical-documentation-rho.vercel.app/
Avoid using long deployment-specific URLs as the primary public profile link unless there is a specific reason.
Final rule
Publish the method, narrative and sanitized evidence.
Do not publish secrets, private evidence or raw operational material.