peterino
/
Backlog
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity
260 Commits 7 Branches 0 Tags 264 MiB
Zig 72.8%
HTML 21.4%
HLSL 2.4%
JavaScript 1.6%
CSS 0.9%
Other 0.9%
Go to file
Peterino2 c23ae441c1 docs: Reorganize and clean up documentation 
Complete documentation overhaul with clear organization and clean structure.

## Changes

### Documentation Reorganization

**New Structure**:
- README.md - Project overview and entry point
- PROJECT_STRUCTURE.md - Complete directory layout
- docs/ - All documentation (organized by category)
- docs/archive/ - Historical planning documents
- test/integration/ - Integration tests

**Removed Duplicates**:
- Consolidated multiple status documents
- Archived planning documents
- Removed redundant guides
- Cleaned up old test files

### New User Documentation

Created clean, focused guides:

1. **README.md** - Project overview, quick start, feature list
2. **docs/GETTING_STARTED.md** - Step-by-step tutorial
3. **docs/API_REFERENCE.md** - Complete CLI reference
4. **docs/QUICKSTART.md** - Quick reference guide

### New Technical Documentation

5. **docs/ARCHITECTURE.md** - System design and components
6. **docs/DEPENDENCY_RESOLUTION.md** - How automatic deps work
7. **docs/KNOWN_ISSUES.md** - Current limitations and workarounds

### New Development Documentation

8. **docs/DEVELOPMENT.md** - Contributing, extending, Zig 0.15 guide
9. **docs/ROADMAP.md** - Future plans and priorities
10. **docs/INDEX.md** - Complete documentation index

### Organized Technical Details

Kept detailed implementation docs in docs/:
- DEPENDENCY_FLOW.md (845 lines) - Technical walkthrough
- VISUAL_FLOW.md (365 lines) - Flow diagrams
- MULTI_FIELD_IMPLEMENTATION.md - Feature implementation
- TYPEDEF_IMPLEMENTATION.md - Feature implementation
- MULTI_HEADER_TEST_RESULTS.md - Test results

### Archived Historical Documents

Moved to docs/archive/:
- Planning documents
- Session summaries
- Status reports
- Implementation notes

These remain available for reference but don't clutter main docs.

## Documentation Statistics

**Before**:
- 18 markdown files in root
- Mix of planning, status, and user docs
- No clear entry point
- Difficult to navigate

**After**:
- 2 files in root (README, PROJECT_STRUCTURE)
- 14 organized docs in docs/
- 9 archived docs in docs/archive/
- Clear hierarchy and index
- Easy navigation

**Lines of Documentation**:
- User guides: ~1,500 lines
- Technical docs: ~2,500 lines
- Implementation details: ~1,500 lines
- **Total: ~5,500 lines** (well-organized)

## Documentation Organization

### By Audience

**New Users**:
1. README.md
2. docs/GETTING_STARTED.md
3. docs/QUICKSTART.md

**Existing Users**:
1. docs/API_REFERENCE.md
2. docs/KNOWN_ISSUES.md

**Developers**:
1. docs/ARCHITECTURE.md
2. docs/DEVELOPMENT.md
3. docs/DEPENDENCY_FLOW.md

### By Purpose

**Learning**: Getting Started, Quickstart, Architecture
**Reference**: API Reference, INDEX, Known Issues
**Development**: DEVELOPMENT, Roadmap, Implementation docs
**History**: archive/ directory

## Benefits

✅ Clear navigation path for all users
✅ Focused documentation (no duplication)
✅ Preserved historical context (archive)
✅ Professional structure
✅ Easy to maintain
✅ Organized test files

## Testing

- All existing tests still in place (test/ and test/integration/)
- Build system unchanged
- No functional changes to parser
- Pure documentation cleanup

---

Impact: Documentation only (no code changes)
Files changed: 50+ (reorganization)
Lines: ~5,500 (well-organized)
Status: Production-ready documentation ✅
 		2026-01-22 14:03:06 -08:00
.github/workflows big rework on automation.py and staging game builds now 2025-10-12 15:24:57 -07:00
archive archiving a lot of things then moving to yet another redo of the build system 2025-11-28 20:22:51 -08:00
build saving 2026-01-19 21:40:05 -08:00
buildgen enabling shader gen 2026-01-08 17:19:52 -08:00
depot updates to engine time and seemingly bugs are fixed 2026-01-03 16:35:31 -08:00
docs adding claude helper files and documentation, also testing parallel-job 2025-10-25 15:08:40 -07:00
engine saving 2026-01-21 22:41:50 -08:00
extras samplegame is now compiling on windows in both debug and static build modes on 0.15 2025-10-19 23:35:28 -07:00
lib docs: Reorganize and clean up documentation 2026-01-22 14:03:06 -08:00
projects updates to engine time and seemingly bugs are fixed 2026-01-03 16:35:31 -08:00
testing replaced all references of std.time.sleep with std.Thread.sleep 2025-10-13 17:56:07 -07:00
tools finished enet 2025-10-13 17:53:42 -07:00
.gitattributes Backlog initial-comit SDL gpu examples cooking shaders properly 2025-04-07 19:51:46 -07:00
.gitignore big rework on automation.py and staging game builds now 2025-10-12 15:24:57 -07:00
CLAUDE.md crated zuck game content and creating hello-window 2025-10-26 20:02:36 -07:00
LICENSE Backlog initial-comit SDL gpu examples cooking shaders properly 2025-04-07 19:51:46 -07:00
README.md saving 2025-12-19 02:18:45 -08:00
build.archive.zig new build system who dis 2025-12-07 14:35:58 -08:00
build.zig saving 2025-12-30 13:55:35 -08:00
build.zig.zon new build system who dis 2025-12-07 14:35:58 -08:00
content.txt content and shader cooking stuff 2025-04-13 14:12:48 -07:00
todo.txt spec generation complete 2025-12-27 22:51:40 -08:00

README.md

Backlog

zig version: 0.15.1

Backlog Labs Game Engine.

Getting Started

run tools/scripts/first-time-setup.py

ffmpeg -i INPUT.mp4 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 OUTPUT.ogv

git-bug Cheat Sheet

This project uses git-bug for distributed issue tracking. Issues are stored directly in the repository.

Common Commands

Listing Issues

git bug bug                    # List all issues
git bug bug status:open        # List only open issues
git bug bug status:closed      # List only closed issues

Creating Issues

git bug bug new -t "title" -m "message"              # Create new issue
git bug bug new -t "Add feature X" -m "Description"  # Example

Viewing & Managing Issues

git bug bug show <id>          # Show issue details
git bug bug comment <id>       # Add a comment to an issue
git bug bug close <id>         # Close an issue
git bug bug open <id>          # Reopen an issue
git bug bug status <id>        # Show issue status

Labels

git bug bug label <id>              # Show labels for an issue
git bug bug label new <id> <label>  # Add a label
git bug bug label rm <id> <label>   # Remove a label

Syncing

git bug pull                   # Pull issue updates from remote
git bug push                   # Push issue updates to remote

Standard Labels

Component Labels: core, rendering, physics, build-system, platform, assets, audio, ui, documentation

Type Labels:

  • bug - Defects or incorrect behavior
  • feature - New functionality
  • enhancement - Improvements to existing features
  • task - General development work
  • documentation - Documentation improvements
  • question - Design decisions or discussions
  • refactoring - Code cleanup

Problem Type Labels (for bugs):

  • memory - Memory issues
  • threading - Concurrency issues
  • crash - Application crashes
  • build - Build system issues

Quick Examples

# Create a bug report
git bug bug new -t "Memory leak in asset loader" -m "Assets not freed when unloading scenes"
git bug bug label new <id> bug assets memory

# Create a feature request
git bug bug new -t "Add terrain generation" -m "Implement heightmap-based terrain"
git bug bug label new <id> feature rendering

# Create a task
git bug bug new -t "Update to Zig 0.15" -m "Migrate to latest Zig version"
git bug bug label new <id> task build-system

# View and comment on an issue
git bug bug show abc123
git bug bug comment abc123

Tips

  • Issue IDs can be abbreviated (first few characters)
  • Use --non-interactive flag for scripting
  • Issues sync with git bug pull/push
  • Keep descriptions factual and clear