Skip to content

FAQ.md has no coverage for basectl demo, repo, workspace, or logs #446

@codeforester

Description

@codeforester

Problem

FAQ.md currently covers: first-time installation, bootstrap modes, Homebrew/source coexistence, setup vs update-profile, workspace root configuration, and the Base vs project-installer boundary.

Four significant commands shipped since the FAQ was written but have no FAQ entries:

  • basectl demo — users will ask: "What is a demo? How do I add one to my project? Why do I need --non-interactive for CI?"
  • basectl repo — users will ask: "What does repo init do? Why does it try to create a GitHub repo? How do I skip that? What is the baseline?"
  • basectl workspace — users will ask: "Do I need workspace.root configured for workspace status to work? What does 'manifest invalid' mean in the status output?"
  • basectl logs — users will ask: "Where are the logs stored? How do I use this to debug a failed setup? Why doesn't -v work when I run it?" (see also issue logs.sh silently drops -v instead of enabling debug logging #423)

Proposed Additions

Add a "Project Commands" FAQ section covering:

  • What is basectl demo and how does a project declare one?
  • What does basectl repo init do and when should I skip GitHub configuration?
  • How do I see workspace health across all my projects?
  • How do I inspect a failed Base command's log output?

The answers can be short (2–4 sentences each) and link to the relevant docs pages for detail. The goal is to surface these commands as discoverable answers to real questions, not to duplicate the docs.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions