Skip to content

Commit 50c8e67

Browse files
committed
chore: reestructure doc
1 parent fd753b3 commit 50c8e67

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,27 +80,32 @@ node interpreter/cli.js path/to/your-code.pseudocode
8080

8181
```bash
8282
stepcode
83-
├── .github/ # GitHub templates for issues and PRs
84-
├── content/ # Source content for the book
85-
│ ├── chapters/ # Markdown files for each lesson/chapter
86-
│ ├── index.md # Landing page content
87-
│ └── stepcode.toml # Book configuration and chapter order
88-
├── interpreter/ # CLI version of the pseudocode interpreter
83+
├── .github/ # GitHub automation (CI/CD) and community templates
84+
├── assets/ # Media and visual assets for documentation
85+
├── docs/ # Source content for the official stepcode book
86+
├── interpreter/ # Core pseudocode engine
8987
│ ├── cli.js # Command-line interface entry point
90-
│ └── tests/ # Unit tests for the parser and interpreter
91-
├── src/ # Site generator source code (Python)
92-
│ ├── generate.py # HTML generation logic and layouts
93-
│ ├── main.py # Main entry point for the generator
94-
│ └── parse_content.py # Logic for parsing Markdown and config files
95-
├── static/ # Assets for the generated site
96-
│ ├── base.css # Global styles
97-
│ └── js/ # Interpreter logic (Lexer, Parser, Runtime)
98-
├── pyproject.toml # Python project configuration and dependencies
99-
├── package.json # Node.js scripts and development dependencies
100-
├── flake.nix # Nix development environment configuration
101-
└── LICENSE.txt # GPL-3.0 License details
88+
│ ├── static/ # Shared logic (Lexer, Parser, Runtime) for CLI and Web
89+
│ └── tests/ # Comprehensive test suite for the interpreter
90+
├── src/ # Static site generator source code (Python)
91+
│ ├── generate.py # HTML layouts and site-building logic
92+
│ └── parse_content.py # Content tree and Markdown parsing
93+
├── static/ # Global UI assets (CSS and frontend entry point)
94+
├── template/ # Boilerplate/Example for creating new books
95+
├── flake.nix # Reproducible Nix development environment
96+
├── pyproject.toml # Python project configuration (uv)
97+
└── package.json # Node.js scripts and development tools
10298
```
10399

100+
### Community & Governance
101+
102+
To ensure a healthy Open Source ecosystem, we maintain:
103+
104+
- **CONTRIBUTING.md**: Guidelines for code, documentation, and bug reports.
105+
- **GOVERNANCE.md**: Clear model for project decision-making.
106+
- **CODE_OF_CONDUCT.md**: Standards for a welcoming community.
107+
- **AUTHORS.md**: Recognition of all project contributors.
108+
104109
### Interpreter diagram
105110

106111
```mermaid

0 commit comments

Comments
 (0)