fix(docs): render the repository-structure tree as a tree #91
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,59 @@ | ||
| # Clone the repository | ||
|
|
||
| git clone https://github.com/hyperpolymath/manifesto.git | ||
| cd manifesto | ||
|
|
||
| # Using Guix (recommended for reproducibility) | ||
|
|
||
| guix develop | ||
|
Contributor
There was a problem hiding this comment. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win Use the documented Guix command.
🤖 Prompt for AI AgentsSource: MCP tools |
||
|
|
||
| # Or using toolbox/distrobox | ||
|
|
||
| toolbox create manifesto-dev | ||
| toolbox enter manifesto-dev | ||
|
Comment on lines
+12
to
+13
Contributor
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Separate Toolbox and Distrobox instructions. The section promises 🧰 Tools🪛 LanguageTool[grammar] ~12-~12: There seems to be a noun/verb agreement error. Did you mean “creates” or “created”? (SINGULAR_NOUN_VERB_AGREEMENT) 🤖 Prompt for AI Agents |
||
| # Install dependencies manually | ||
|
Contributor
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: sed -n '1,40p' .github/CONTRIBUTING.md
sed -n '12,45p' QUICKSTART-DEV.adoc
rg -n 'setup-dev|install.*depend|toolbox|distrobox|devcontainer' Justfile justfile .github QUICKSTART-DEV.adoc 2>/dev/nullRepository: hyperpolymath/manifesto Length of output: 1761 🏁 Script executed: set -o pipefail
printf '%s\n' '--- candidate files ---'
git ls-files | grep -E '(^|/)(Justfile|justfile|.*devcontainer.*|.*setup.*)$' || true
printf '%s\n' '--- relevant references ---'
rg -n -C 4 'setup-dev|install|dependency|toolbox|distrobox|devcontainer' --glob 'Justfile' --glob 'justfile' --glob '.devcontainer/**' --glob 'Dockerfile*' --glob '*.yml' --glob '*.yaml' --glob '*.md' --glob '*.adoc' . 2>/dev/null || trueRepository: hyperpolymath/manifesto Length of output: 7982 🏁 Script executed: set -o pipefail
git ls-files | grep -E '(^|/)(Justfile|justfile|.*devcontainer.*|.*setup.*)$' || true
rg -n -C 4 'setup-dev|install|dependency|toolbox|distrobox|devcontainer' --glob 'Justfile' --glob 'justfile' --glob '.devcontainer/**' --glob 'Dockerfile*' --glob '*.yml' --glob '*.yaml' --glob '*.md' --glob '*.adoc' . 2>/dev/null || trueRepository: hyperpolymath/manifesto Length of output: 7930 🏁 Script executed: printf '%s\n' '--- Justfile ---'
cat -n Justfile
printf '%s\n' '--- setup.sh references ---'
cat -n setup.sh | sed -n '1,220p'Repository: hyperpolymath/manifesto Length of output: 13057 🏁 Script executed: printf '%s\n' '--- imported recipe candidates ---'
find . -type f \( -name 'contractile.just' -o -name 'Justfile' -o -name 'justfile' \) -print
printf '%s\n' '--- imported file reference ---'
if [ -f contractile.just ]; then cat -n contractile.just; else printf '%s\n' 'contractile.just not present at repository root'; fi
printf '%s\n' '--- contractiles Justfile setup references ---'
rg -n -C 5 '(^|[[:space:]])setup(-dev)?([[:space:]:]|$)|dependency|install' .machine_readable/contractiles/Justfile 2>/dev/null || trueRepository: hyperpolymath/manifesto Length of output: 3375 Document the supported Toolbox dependency setup. This section states that dependencies must be installed manually but provides no command or dependency list. Do not add 🧰 Tools🪛 markdownlint-cli2 (0.23.2)[warning] 14-14: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 🤖 Prompt for AI Agents |
||
|
|
||
| # Verify setup | ||
|
|
||
| just check # or: cargo check / mix compile / etc. | ||
| just test # Run test suite | ||
|
|
||
| ### Repository Structure | ||
|
Contributor
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Use a valid heading level for This heading jumps to level 3 instead of starting at level 2. Change 🧰 Tools🪛 markdownlint-cli2 (0.23.2)[warning] 21-21: Heading levels should only increment by one level at a time (MD001, heading-increment) 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
|
|
||
| ```text | ||
| manifesto/ | ||
| ├── src/ # Source code (Perimeter 1-2) | ||
| ├── lib/ # Library code (Perimeter 1-2) | ||
| ├── extensions/ # Extensions (Perimeter 2) | ||
| ├── plugins/ # Plugins (Perimeter 2) | ||
| ├── tools/ # Tooling (Perimeter 2) | ||
| ├── docs/ # Documentation (Perimeter 3) | ||
| │ ├── architecture/ # ADRs, specs (Perimeter 2) | ||
| │ └── proposals/ # RFCs (Perimeter 3) | ||
| ├── examples/ # Examples (Perimeter 3) | ||
| ├── spec/ # Spec tests (Perimeter 3) | ||
| ├── tests/ # Test suite (Perimeter 2-3) | ||
| ├── .well-known/ # Protocol files (Perimeter 1-3) | ||
| ├── .github/ # GitHub config (Perimeter 1) | ||
| │ ├── CONTRIBUTING.md # This file | ||
| │ ├── ISSUE_TEMPLATE/ | ||
| │ └── workflows/ | ||
| ├── CHANGELOG.md | ||
| ├── CODE_OF_CONDUCT.md | ||
| ├── GOVERNANCE.md | ||
| ├── LICENSE | ||
| ├── MAINTAINERS.md | ||
| ├── README.adoc | ||
| ├── SECURITY.md | ||
| ├── flake.nix # Nix flake (Perimeter 1) | ||
| └── Justfile # Task runner (Perimeter 1) | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| ### Reporting Bugs | ||
|
Contributor
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Dedent the content below the headings. The headings are now normal Markdown headings, but their following prose and lists remain indented by four spaces. Markdown renders those blocks as code, so the reporting, feature, first-contribution, and commit guidance sections do not render as normal text and lists. Remove the unintended indentation from those bodies. Also applies to: 73-73, 89-89, 110-110 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
|
|
||
| **Before reporting**: | ||
| 1. Search existing issues | ||
|
|
@@ -54,7 +70,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1) | |
| - Expected vs actual behaviour | ||
| - Logs, screenshots, or minimal reproduction | ||
|
|
||
| ### Suggesting Features | ||
|
|
||
| **Before suggesting**: | ||
| 1. Check the [roadmap](ROADMAP.md) if available | ||
|
|
@@ -70,7 +86,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1) | |
| - Alternatives considered | ||
| - Which perimeter this affects | ||
|
|
||
| ### Your First Contribution | ||
|
|
||
| Look for issues labelled: | ||
|
|
||
|
|
@@ -81,22 +97,25 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1) | |
|
|
||
| --- | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| ### Branch Naming | ||
|
|
||
| docs/short-description # Documentation (P3) test/what-added # Test | ||
| additions (P3) feat/short-description # New features (P2) | ||
| fix/issue-number-description # Bug fixes (P2) refactor/what-changed # | ||
| Code improvements (P2) security/what-fixed # Security fixes (P1-2) | ||
|
Comment on lines
+104
to
+107
Contributor
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Reflow the branch examples. The hard wraps join 🤖 Prompt for AI Agents |
||
|
|
||
|
|
||
| ### Commit Messages | ||
|
|
||
| We follow [Conventional Commits](https://www.conventionalcommits.org/): | ||
|
|
||
| type(scope): description | ||
|
|
||
| Body: what changed and why. | ||
|
|
||
| Footer: issue reference, e.g. Closes #123 | ||
| \[optional body\] | ||
|
|
||
| \[optional footer\] | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fence the setup commands.
Lines 1-19 are not inside a fenced code block. Markdown parses each
# ...line as a heading and renders the commands as ordinary prose. Wrap the complete shell sequence in a fencedbashblock so contributors can read and copy it as commands.🤖 Prompt for AI Agents
Source: Linters/SAST tools