Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.16 KB

File metadata and controls

83 lines (56 loc) · 2.16 KB

Oro Website

This directory contains the static website for Oro Computer, including landing pages and documentation for:

  • Oro Runtime (website/runtime/)
  • Silk (website/silk/)
  • Virtnosis (website/virtnosis/)

The public top-level navigation is intentionally small:

  • Technology (website/index.html) presents Oro Runtime, Silk, and Virtnosis.
  • Blog (website/blog/) is a static placeholder for future engineering notes.
  • Docs (website/docs/) routes readers into Runtime and Silk documentation.

Legacy Sage and slg pages remain in the repository for continuity, but they are not promoted from the top-level navigation or docs hub.

Runtime docs

Runtime docs use the same docs viewer UX as Silk docs (sidebar, search, prev/next, deep links).

  • Viewer: website/runtime/docs/index.html
  • Markdown sources: website/runtime/docs/source/
  • Generated indexes:
    • website/runtime/docs/index.json
    • website/runtime/docs/search.json
  • LLM pack: website/runtime/llms.txt

Rebuild generated files after changing sources:

python3 website/runtime/tools/build-indexes.py
python3 website/runtime/tools/build-llms-txt.py

Silk docs

  • Docs viewer: website/silk/docs/index.html
  • Wiki viewer: website/silk/wiki/index.html
  • Generators live in website/silk/tools/.

Rebuild generated files:

python3 website/silk/tools/build-indexes.py
python3 website/silk/tools/build-llms-txt.py

To refresh the website copy from the sibling Silk compiler checkout:

python3 website/silk/tools/sync-from-silk-docs.py

Virtnosis docs

  • Docs viewer: website/virtnosis/docs/index.html
  • Markdown sources: website/virtnosis/docs/source/

Rebuild generated files:

python3 website/virtnosis/tools/build-indexes.py
python3 website/virtnosis/tools/build-llms-txt.py

slg docs

  • Docs viewer: website/slg/docs/index.html
  • Markdown sources: website/slg/docs/source/

Rebuild generated files:

python3 website/slg/tools/build-indexes.py
python3 website/slg/tools/build-llms-txt.py

Shared docs viewer

Runtime, Silk, Virtnosis, Sage, and slg use the shared docs viewer:

  • website/assets/docs-viewer.js