Skip to content

Docs: close the demo-to-framework onboarding gap (link base-cli, minimal starter, docs index, skills.md) #20

Description

@codeforester

Problem

Once the demo has convinced someone, there is no smooth path from "I like this"
to "I am using base-cli in my own project":

  • The README never links to the framework. The only basefoundry
    repository link in README.md is ## Base →
    https://github.com/basefoundry/base (the meta-tool), at line 125. The
    base-cli repo and its docs are linked only at the very bottom of
    docs/learning-path.md (lines 106-110). Someone evaluating base-cli from this
    demo has to guess the URL.
  • There is no minimal "use it in your own project" starter. Northstar is a
    deliberately production-shaped app (nested commands, fixtures, config adapter,
    optional integrations). There is no smallest possible consumer: a fresh
    project, pip install base-cli, ~10 lines wiring base_cli.App +
    one command, run it. That is what a new adopter copies first.
  • skills.md is an unfilled template. It still contains the
    "## Suggested Entries" placeholder from the baseline rather than real
    repo-specific guidance.
  • docs/ has no index. Six docs, linked ad hoc from README prose, with no
    "start here → next → next" reading order for an evaluator.

Suggested fix

  • Add a top-of-README link block: base-cli repo, base-cli README/getting-started,
    API reference.
  • Add docs/use-in-your-project.md (or a README section) with a copy-pasteable
    minimal consumer — new project, dependency line, ~10-line main, expected
    output — separate from the full Northstar tour.
  • Replace skills.md placeholder content with the repo's actual workflows.
  • Add docs/README.md (or a README "Documentation" list) giving an ordered
    path: why → should-I-use → five-minute learning path → lifecycle safety →
    configuration → compatibility → release.

Acceptance

  • From the demo README, a reader reaches the base-cli repo in one click and has
    a minimal, runnable starter they can lift into their own project without
    reading the entire Northstar source.

Activity

  1. added this to the v0.1.0 milestone on Sep 12, 2026
  2. self-assigned this
    on Sep 12, 2026
  3. codeforester commented on Sep 12, 2026

    @codeforester
    ContributorAuthor

    2026-09-12 repository review refresh

    Reconfirmed the missing top-level framework link/minimal own-project handoff and placeholder skills.md. The smallest successful learning outcome is a newcomer independently adding one command and testing success, a usage error and a dry run in a separate project. Preserve Northstar as the next realistic example rather than forcing newcomers to copy its full fixture/config setup. Link documentation to compatible released framework behavior.

    Validated against current main (2de6b83f21ccacae04f8050f5691d0dd8159fda1). This review files and scopes work; it does not claim implementation or authorize release/admin changes.

  4. moved this from Backlog to In Progress in base-cli-demoon Sep 18, 2026
  5. moved this from In Progress to In Review in base-cli-demoon Sep 18, 2026
  6. codeforester commented on Sep 19, 2026

    @codeforester
    ContributorAuthor

    Implemented by merged PR #33: documentation index, framework resource links, copyable minimal Click consumer, runnable example/test, and repository skills.

  7. moved this from In Review to Done in base-cli-demoon Sep 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions