Documentation site: guides and API reference on docs.tortal.tech/SavePoint #142
No reviewers
Labels
No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
ethan-hann/SavePoint!142
Loading…
Reference in a new issue
No description provided.
Delete branch "docs-site"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Builds one static site from the guides in docs/ and an API reference generated from Savepoint.Core's doc comments, with DocFX as a local tool (docfx.json, docfx/). The site uses the app's look: the Material roles the app derives from the default Blue accent in light and dark, the app's Roboto files, and the app icon as logo and favicon.
.forgejo/workflows/docs.yml builds the site with warnings as errors on pull requests that touch its sources, and publishes it to the git-pages server at docs.tortal.tech under the path SavePoint on pushes to main that change those sources and on v* tags. The host is shared with other projects, so the workflow refuses an empty path. The upload is authorized by the workflow token and the _git-pages-forge-allowlist TXT record; the repository variable DOCS_SITE_URL is set.
The gate now treats docfx.json and docfx/ as documentation, so a change to the guides or the site alone takes the short path. The developer guide documents the site and the server setup, and D55 records the choice.