stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
d0f2cc3b2cf0dfa4b1ea69737ad5ebd02089fbc6
git.stella-ops.org/docs/features/checked/devportal/developer-portal.md
master 5bca406787 save checkpoint: save features
2026-02-12 10:27:23 +02:00

3.0 KiB
Raw Blame History

Developer Portal (Astro/Starlight)

Module

DevPortal

Status

VERIFIED

Description

Static developer portal built with Astro/Starlight, including API reference pages, try-it console assets, docs guides, and offline bundle packaging suitable for offline/air-gapped delivery.

Implementation Details

  • Astro/Starlight Site: src/DevPortal/StellaOps.DevPortal.Site/
  • Content Configuration: src/DevPortal/StellaOps.DevPortal.Site/src/content/config.ts
  • API Reference Page: src/DevPortal/StellaOps.DevPortal.Site/src/content/docs/api-reference.mdx
  • Getting Started Guide: src/DevPortal/StellaOps.DevPortal.Site/src/content/docs/guides/getting-started.mdx
  • Navigation Search Guide: src/DevPortal/StellaOps.DevPortal.Site/src/content/docs/guides/navigation-search.mdx
  • OpenAPI Spec: src/DevPortal/StellaOps.DevPortal.Site/public/api/stella.yaml
  • Try-It Console Assets:
    • src/DevPortal/StellaOps.DevPortal.Site/public/js/try-it-console.js
    • src/DevPortal/StellaOps.DevPortal.Site/public/js/rapidoc-loader.js
    • src/DevPortal/StellaOps.DevPortal.Site/public/js/api-reference.js
  • Build/Validation Scripts:
    • src/DevPortal/StellaOps.DevPortal.Site/scripts/build-offline.mjs
    • src/DevPortal/StellaOps.DevPortal.Site/scripts/check-links.mjs
    • src/DevPortal/StellaOps.DevPortal.Site/scripts/check-perf.mjs
    • src/DevPortal/StellaOps.DevPortal.Site/scripts/run-a11y.mjs
    • src/DevPortal/StellaOps.DevPortal.Site/scripts/sync-spec.mjs
  • Integrity Check: src/DevPortal/StellaOps.DevPortal.Site/SHA256SUMS.devportal-stubs

E2E Test Plan

  • Build site and verify static output generation
  • Build offline bundle and verify archive output generation
  • Run link checker and verify no broken links
  • Run accessibility script (with deterministic skip behavior on unsupported host deps)
  • Run distribution budget check
  • Verify SHA256SUMS entry matches referenced artifact

Verification

  • Verified: 2026-02-11
  • Method: Tier 0 source verification + Tier 1 build + Tier 2 integration/CLI script replay
  • Tier 0 Evidence: docs/qa/feature-checks/runs/devportal/developer-portal/run-001/tier0-source-check.json
  • Tier 1 Evidence: docs/qa/feature-checks/runs/devportal/developer-portal/run-001/tier1-build-check.json
  • Tier 2 Evidence: docs/qa/feature-checks/runs/devportal/developer-portal/run-001/tier2-integration-check.json
  • Tests/Checks:
    • npm install
    • npm run sync:spec
    • npm run build
    • npm run build:offline
    • npm run lint:links
    • npm run test:a11y
    • npm run budget:dist
    • SHA256 verification against SHA256SUMS.devportal-stubs

Notes

  • DevPortal scripts were patched for cross-platform reliability:
    • Windows-safe npm invocation in build/preview scripts.
    • Safe process cleanup when pkill is unavailable.
    • Correct ESM path resolution in perf checks.
    • Link checker fallback for hosts serving directory pages via /index.html.
    • Offline tar packaging fallback when host tar lacks GNU deterministic flags.