Skip to content

docs: align install quickstart with v0.13.0 product behavior#755

Open
bussyjd wants to merge 2 commits into
mainfrom
docs/hackathon-quickstart-accuracy
Open

docs: align install quickstart with v0.13.0 product behavior#755
bussyjd wants to merge 2 commits into
mainfrom
docs/hackathon-quickstart-accuracy

Conversation

@bussyjd

@bussyjd bussyjd commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Hackathon setup feedback on docs mismatches vs v0.13.0 product:

  • Pin OBOL_RELEASE example to v0.13.0 (live docs.obol.org still shows v0.9.0).
  • Document /etc/hosts resume path (stack init / stack up / agent init) and OBOL_NONINTERACTIVE=true.
  • Document Ollama decline → default Hermes skipped until obol model setup + obol agent init.
  • Correct tunnel dormant until first sell / tunnel restart (not always-on quick-tunnel).
  • Prominently document http://obol.stack:8080 and that localhost:8080 is 404 (Traefik Host: obol.stack).

Also adds docs/guides/docs-obol-org-hackathon-gaps.md with a claim-by-claim verdict and drop-in GitBook copy for the external site (docs.obol.org is not sourced from this repo).

Test plan

  • Review README + getting-started for accuracy against stack up / EnsureHostsEntries / tunnel dormant message
  • Apply same copy edits on docs.obol.org GitBook (Intro, Quickstart, FAQ) from the gap guide

Hackathon setup feedback: pin OBOL_RELEASE to a current tag, document
hosts resume + OBOL_NONINTERACTIVE, Ollama-skip skipping Hermes, dormant
tunnel, and that Traefik needs Host: obol.stack (localhost:8080 is 404).
Include a GitBook gap list for docs.obol.org.
@@ -0,0 +1,75 @@
# docs.obol.org gaps (hackathon setup feedback)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably delete this file?

Signed-off-by: JeanDaniel Bussy <SilverSurfer972@gmail.com>
bussyjd added a commit that referenced this pull request Jul 16, 2026
Drop the temporary GitBook gap checklist from the integration train;
product docs live in README + docs/getting-started.md only.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants