Skip to content

S9 — The onboarding guide's [Internal Tech Guide] link is empty #82

Description

@Polichinel

Epic: views-platform/views-appwrite#26 · Depends on: S8 (views-platform/views-models#311) · Blocks: nothing

Problem — a pointer to nothing is worse than no pointer

Onboarding Resources/views_platform_onboarding_guide.md is the platform's entry point for humans. It has an empty link exactly where technical setup belongs:

  • Line 31: [Internal Tech Guide]() — literally empty parentheses
  • Line 71: [Internal Tech Guide] — no link at all

A reader following the one documented entry point arrives at nothing, and concludes the answer exists and they failed to find it. That is worse than an honest absence.

Two further gaps, both verified by reading the file:

  • It mentions no .env, no credentials, no environment variables at all. Setting up the platform requires both, and the guide is silent.
  • It lists 6 repositories. The workspace contains 20+, including every repo on the Appwrite seam — views-appwrite, views-faoapi, views-postprocessing, views-datafactory, views-frames, views-models itself.

Context

This is the last story of an epic that made setup executable: views-platform/views-models#311 delivers bootstrap.sh, tested in CI without real credentials. This issue points the guide at it.

The epic is deliberately ordered so documentation comes last — by this point the setup path is a program that must work, so the guide describes something verified rather than something asserted.

Work

  1. Resolve or remove both [Internal Tech Guide] references. If the destination is bootstrap.sh, link it. If there is no destination, delete the reference — an honest gap beats a broken promise.
  2. Add a short setup section, or link one: clone the repos, run bootstrap.sh, supply one secret. It should be short enough to stay true; the current guide is 87 lines and already stale at 6 repos.
  3. Refresh the repository list, or state plainly that it is a starting subset and point at a complete index.

Acceptance criteria

  • No empty or dangling [Internal Tech Guide] link remains
  • A reader can get from this guide to a working setup without reading source
  • The repository list is either current or explicitly scoped as a subset
  • Every link in the touched sections resolves — checked, not assumed

Validation

Follow the guide end to end as someone who has never seen the platform. Every step must be executable from the document alone. If a step requires opening a repo's source to act on, it is not done.

Note

Filed by the views-appwrite seat as part of epic views-platform/views-appwrite#26. This repo owns the guide; the epic owns the setup path it should point at.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions