Docs-As-Code

This is the tool / toolchain for documentation in the S-CORE ecosystem. It provides documentation, requirements, and traceability.

How to

Learn how to integrate and use docs-as-code.

Reference

API and usage reference.

Concepts

Key concepts, models and explanatory material to understand the system.

Sitemap

• How To
  • Getting started
  • Setup
  • Write Documentation
  • Reference Other Modules
  • Handle Cross-Module Compatibility Findings
  • Hierarchical Needs with upward_bundles
  • Mount docs bundles
  • Build Dashboards and Quality Gates
  • Reference Docs in Source Code
  • Reference Docs in Tests
  • Integrate Generated Documentation
  • Add Extensions
• Reference
  • Commands
  • Bazel macro: docs
  • Metamodel Types Visualization
• Concepts
  • Bi-directional Traceability
  • Cross-Module Compatibility
  • Docs Dependencies
  • Hierarchically linked bundle Needs exports
  • Documentation bundles and mounts
• Internals
  • Bazel Mini Benchmark Results
  • Decisions And Concepts
    • Decision Record 001: Test results in Docs-As-Code Workflows
  • Requirements
    • Capabilities - A High Level Overview
    • Process Requirements Overview
    • Tool Requirements
    • Requirement Test Coverage
    • Tooling Verification
  • Extensions
    • Metamodel
    • Filebased Testing
    • Source Code Linker
    • Extension Guide
    • Sync TOML
    • Mounts extension internals