Pharos Framework

← Back

Tutorial: Build And Serve The Documentation App

This tutorial uses dev_docs, the checked Pharos documentation app.

dev_docs is useful because it shows two important framework behaviors at once:

  • normal app packaging from a checked app root
  • build-time assembly of repository docs and generated Doxygen output into the final app artifact

Build

pharos build app dev_docs --build-dir dist --text

Expected artifact root:

dist/apps/dev_docs/

Important generated content includes:

dist/apps/dev_docs/docs/
dist/apps/dev_docs/docs/html/

docs/html/ is generated Doxygen output and is intentionally not a source-of-truth subtree in the repository.

Serve

pharos serve app dev_docs --build-dir dist --port 8083 --text

Open:

http://127.0.0.1:8083/dev_docs/

What this shows

dev_docs demonstrates that Pharos can package documentation as a normal app bundle while still assembling generated content at build time.

That same pattern is useful for other apps that need:

  • generated assets produced during build
  • reviewable packaged output under dist/apps/<app_id>/
  • a shared runtime serving multiple apps under base paths

Inspect the packaged app

Check these packaged paths:

dist/apps/dev_docs/index.html
dist/apps/dev_docs/docs/pharos_framework.html
dist/apps/dev_docs/docs/pharos.html
dist/apps/dev_docs/docs/html/index.html

This makes dev_docs a good reference for how Pharos packages app-owned content together with framework-generated output.

Next

  • Build a declarative dynamic app
  • Framework overview