Skip to content

Conversation

@Sendi0011
Copy link
Contributor

Changes

  • ✅ Added Makefile with common development tasks
  • ✅ Added docs/development.md with comprehensive development setup guide
  • ✅ Added docs/makefile.md with detailed Makefile reference documentation
  • ✅ Updated mkdocs.yml navigation to include new Development section

Features Added

Makefile Targets

Build & Test:

  • make build - Build in debug mode
  • make release - Build optimized release
  • make test - Run all tests
  • make clean - Clean build artifacts

Code Quality:

  • make format - Format code with rustfmt
  • make lint - Run clippy linter
  • make dev - Complete pre-commit checks (format + lint + test)

Documentation:

  • make docs-serve - Serve MkDocs documentation locally
  • make docs-build - Build documentation
  • make doc - Generate Rust documentation

Installation:

  • make install - Install goboscript globally
  • make uninstall - Remove installation

Development Workflows:

  • make quick - Fast build and test cycle
  • make full - Complete development pipeline
  • make help - Show all available commands

Documentation

  • Development Guide: Complete setup instructions for contributors
  • Makefile Reference: Detailed documentation with examples
  • Integrated: Seamlessly works with existing MkDocs site

Testing Completed

  • make help displays comprehensive command list
  • make build builds goboscript successfully
  • make test runs all tests (4 tests passed)
  • make install installs binary correctly
  • make docs-serve serves documentation at http://127.0.0.1:8000/goboscript/
  • Documentation navigation works in MkDocs site
  • All Makefile targets execute successfully

Example Usage

# Quick development cycle
make dev          # Format, lint, and test

# Build and install
make release
make install

# Serve documentation locally  
make docs-serve

# See all available commands
make help

Fixes aspizu#122 - adds missing link to https://github.com/goboscript/std
in the standard library documentation page
- Add comprehensive Makefile with build, test, and development workflow targets
- Add development guide with setup instructions and best practices
- Add detailed Makefile reference documentation
- Update mkdocs.yml navigation to include Development section
- Support for MkDocs documentation serving via make docs-serve

Closes aspizu#182
@aspizu
Copy link
Owner

aspizu commented Aug 3, 2025

slop

@aspizu aspizu closed this Aug 3, 2025
@Sendi0011 Sendi0011 deleted the fix-182-add-makefile-example-to-goboscript-new-and-documentation branch August 3, 2025 16:45
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