Skip to content

docs: sync GemminiBall, Verilator, and build system documentation#1

Draft
cursor[bot] wants to merge 1 commit intomainfrom
cursor/buckyball-documentation-sync-0f85
Draft

docs: sync GemminiBall, Verilator, and build system documentation#1
cursor[bot] wants to merge 1 commit intomainfrom
cursor/buckyball-documentation-sync-0f85

Conversation

@cursor
Copy link
Contributor

@cursor cursor bot commented Mar 17, 2026

This PR adds comprehensive documentation for recent Buckyball changes:

New Documentation

  1. GemminiBall Architecture (content/*/Guide/GemminiBall Architecture.md)

    • Architecture overview and core modules
    • Instruction routing by funct7 (recent encoding update)
    • Execution paths and configuration registers
    • ROB tracking and integration with Buckyball
  2. Verilator Simulation and CI (content/*/Guide/Verilator Simulation and CI.md)

    • Clock and timing improvements (rising-edge detection, mmio_tick debouncing)
    • Memory section handling in BBSimHarness
    • Running tests and CI pipeline configuration
    • Debugging waveforms and troubleshooting
  3. Development Workflow and Build System (content/*/Guide/Development Workflow and Build System.md)

    • Nix Flakes setup and development environment
    • bbdev tool usage and Verilator simulation
    • Code organization and subsystem overview
    • Common development tasks and testing

Coverage

  • Codepaths: arch/framework/balldomain/prototype/gemmini/, sims/verilator/, build system
  • Recent commits: GemminiBall features, instruction encoding updates, Verilator config fixes, bbdev updates

Both English and Chinese documentation are included.

Open in Web View Automation 

- Add GemminiBall Architecture guide: instruction routing, funct7 encoding, configuration and execution paths
- Add Verilator Simulation and CI guide: clock handling improvements, memory configuration, test execution
- Add Development Workflow and Build System guide: Nix setup, bbdev tool usage, common tasks
- Update .order.json to include new Guide section
- Sync both English and Chinese documentation

Co-authored-by: Shiroha <whmio0115@gmail.com>
@shirohasuki
Copy link
Member

No checks have been carried out to ensure that recent commits have not rendered parts of the existing documentation out of date
Recent commits regarding Goban are missing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants