-
Notifications
You must be signed in to change notification settings - Fork 1
docs: restructure README for star conversion #480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
30fb9b9
docs: restructure readme for star conversion
djm81 bfbb630
docs: sync readme change tracking
djm81 42593c1
docs: relocate readme support artifacts
djm81 c998550
docs: fix readme workflow snippet and pin demo capture
djm81 2924c94
docs: address remaining readme review findings
djm81 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
70 changes: 70 additions & 0 deletions
70
docs/_support/readme-first-contact/capture-readme-output.sh
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| REPO_ROOT="$(cd "$SCRIPT_DIR/../../.." && pwd)" | ||
|
|
||
| CLI_VERSION="${CLI_VERSION:-0.45.1}" | ||
| REPO_SLUG="${REPO_SLUG:-nold-ai/specfact-demo-repo}" | ||
| CAPTURE_REF="${CAPTURE_REF:-${CAPTURE_COMMIT:-2b5ba8cd57d16c1a1f24463a297fdb28fbede123}}" | ||
| WORK_DIR="${WORK_DIR:-/tmp/specfact-demo-repo}" | ||
| CAPTURE_HOME="${CAPTURE_HOME:-/tmp/specfact-readme-capture-home}" | ||
| OUTPUT_DIR="${OUTPUT_DIR:-$REPO_ROOT/docs/_support/readme-first-contact/sample-output}" | ||
| RAW_OUTPUT_PATH="${RAW_OUTPUT_PATH:-$OUTPUT_DIR/review-output.txt}" | ||
| SUMMARY_PATH="${SUMMARY_PATH:-$OUTPUT_DIR/capture-metadata.txt}" | ||
| INIT_OUTPUT_PATH="${INIT_OUTPUT_PATH:-$OUTPUT_DIR/init-output.txt}" | ||
|
|
||
| mkdir -p "$OUTPUT_DIR" | ||
| rm -rf "$CAPTURE_HOME" | ||
| mkdir -p "$CAPTURE_HOME" | ||
|
|
||
| if [[ ! -d "$WORK_DIR/.git" ]]; then | ||
| rm -rf "$WORK_DIR" | ||
| gh repo clone "$REPO_SLUG" "$WORK_DIR" | ||
| fi | ||
|
djm81 marked this conversation as resolved.
|
||
|
|
||
| git -C "$WORK_DIR" fetch --all --tags --prune | ||
| git -C "$WORK_DIR" checkout --force "$CAPTURE_REF" | ||
| git -C "$WORK_DIR" reset --hard "$CAPTURE_REF" | ||
|
|
||
| export HOME="$CAPTURE_HOME" | ||
|
|
||
| uvx --from "specfact-cli==$CLI_VERSION" specfact init --profile solo-developer \ | ||
| >"$INIT_OUTPUT_PATH" 2>&1 | ||
|
|
||
| pushd "$WORK_DIR" >/dev/null | ||
| uvx \ | ||
| --from "specfact-cli==$CLI_VERSION" \ | ||
| --with ruff \ | ||
| --with radon \ | ||
| --with semgrep \ | ||
| --with basedpyright \ | ||
| --with pylint \ | ||
| --with crosshair-tool \ | ||
| specfact code review run --path . --scope full \ | ||
| >"$RAW_OUTPUT_PATH" 2>&1 | ||
| REVIEW_EXIT_CODE=$? | ||
| popd >/dev/null | ||
|
djm81 marked this conversation as resolved.
|
||
|
|
||
| cat >"$SUMMARY_PATH" <<EOF | ||
| # README sample output capture | ||
|
|
||
| - CLI version: \`$CLI_VERSION\` | ||
| - Repo: \`$REPO_SLUG\` | ||
| - Repo ref: \`$CAPTURE_REF\` | ||
| - Repo path: \`$WORK_DIR\` | ||
| - Capture home: \`$CAPTURE_HOME\` | ||
| - Review exit code: \`$REVIEW_EXIT_CODE\` | ||
| - Command: | ||
|
|
||
| \`\`\`bash | ||
| uvx --from "specfact-cli==$CLI_VERSION" specfact init --profile solo-developer | ||
| uvx --from "specfact-cli==$CLI_VERSION" --with ruff --with radon --with semgrep --with basedpyright --with pylint --with crosshair-tool specfact code review run --path . --scope full | ||
| \`\`\` | ||
|
|
||
| - Raw output: \`$RAW_OUTPUT_PATH\` | ||
| - Init output: \`$INIT_OUTPUT_PATH\` | ||
| EOF | ||
|
djm81 marked this conversation as resolved.
|
||
|
|
||
| exit "$REVIEW_EXIT_CODE" | ||
17 changes: 17 additions & 0 deletions
17
docs/_support/readme-first-contact/sample-output/capture-metadata.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # README sample output capture | ||
|
|
||
| - CLI version: `0.45.1` | ||
| - Repo: `nold-ai/specfact-demo-repo` | ||
| - Repo ref: `2b5ba8cd57d16c1a1f24463a297fdb28fbede123` | ||
| - Review exit code: `1` | ||
| - Repo path: `/tmp/specfact-demo-repo` | ||
| - Capture home: `/tmp/specfact-readme-capture-home` | ||
| - Command: | ||
|
|
||
| ```bash | ||
| uvx --from "specfact-cli==0.45.1" specfact init --profile solo-developer | ||
| uvx --from "specfact-cli==0.45.1" --with ruff --with radon --with semgrep --with basedpyright --with pylint --with crosshair-tool specfact code review run --path . --scope full | ||
| ``` | ||
|
|
||
| - Raw output: `/workspace/docs/_support/readme-first-contact/sample-output/review-output.txt` | ||
| - Init output: `/workspace/docs/_support/readme-first-contact/sample-output/init-output.txt` |
45 changes: 45 additions & 0 deletions
45
docs/_support/readme-first-contact/sample-output/init-output.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| Downloading pygments (1.2MiB) | ||
| Downloading pydantic-core (2.0MiB) | ||
| Downloading cryptography (4.3MiB) | ||
| Downloading beartype (1.3MiB) | ||
| Downloading networkx (2.0MiB) | ||
| Downloaded pydantic-core | ||
| Downloaded cryptography | ||
| Downloaded pygments | ||
| Downloaded beartype | ||
| Downloaded networkx | ||
| Installed 60 packages in 32ms | ||
|
|
||
| βββββββββββββββ ββββββββ βββββββββββββββ ββββββ ββββββββββββββββ | ||
| βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ | ||
| ββββββββββββββββββββββ βββ ββββββ βββββββββββ βββ | ||
| βββββββββββββββ ββββββ βββ ββββββ βββββββββββ βββ | ||
| βββββββββββ βββββββββββββββββββ βββ βββββββββββ βββ | ||
| βββββββββββ ββββββββ ββββββββββ βββ βββ βββββββ βββ | ||
|
|
||
| Spec β Contract β Sentinel for Contract-Driven Development | ||
|
|
||
|
|
||
|
|
||
| β±οΈ Started: 2026-04-03 20:55:08 | ||
| β Profile solo-developer: preparing workflow bundlesβ¦ | ||
| β Seeding workflow bundles: specfact-codebase, specfact-code-review | ||
| (copying bundled modules into your user module directory) | ||
| β Bundle specfact-codebase β Codebase quality (analyze, drift, validate, repro) | ||
| Β· Installing marketplace module nold-ai/specfact-codebase β¦ | ||
| β specfact-codebase ready | ||
| β Bundle specfact-code-review β Scored code review (code review gate) | ||
| Β· Installing marketplace module nold-ai/specfact-code-review β¦ | ||
| β specfact-code-review ready | ||
| β Installed: specfact-codebase, specfact-code-review | ||
| β Discovering installed modules and writing registry stateβ¦ | ||
| β Indexing CLI commands for help cacheβ¦ | ||
| β Bootstrap complete. Modules discovered: 7 (enabled=7, disabled=0). | ||
| Module management has moved to `specfact module` (for example: `specfact module | ||
| list`, `specfact module init`) | ||
| β Checking IDE prompt export statusβ¦ | ||
| Prompt status: missing=7, outdated=0 for detected IDE (cursor). | ||
| Run: specfact init ide --ide cursor | ||
| Use `specfact init ide` to install/update IDE prompts and settings. | ||
|
|
||
| β Finished: 2026-04-03 20:55:22 | Duration: 13.55s |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.