Skip to content

Conversation

0xRiz0
Copy link
Contributor

@0xRiz0 0xRiz0 commented Sep 25, 2025

PR Description

Summary

This PR introduces new .PHONY targets to the makefile for local development environments and documentation workflows. These additions improve clarity, maintainability, and usability of developer commands by ensuring common tasks are properly declared as phony.


Changes

  1. Anvil Targets

    • Added .PHONY entries for:
      • anvil
      • anvil-fork
      • anvil-polygon
    • Ensures local blockchain development and forked environments are correctly marked as non-file targets.
    • Prevents issues if files or directories happen to share the same names.
  2. Documentation Targets

    • Added .PHONY entries for:
      • docs
      • docs-serve
    • Improves reliability of documentation generation and serving commands.

Why

  • Declaring frequently used commands as phony avoids conflicts with existing files/directories.
  • Provides better developer experience by making targets more predictable and explicit.
  • Helps enforce consistent behavior across environments (local dev, forks, polygon testing, and docs hosting).

Impact

  • ✅ No breaking changes.
  • ✅ Cleaner build and workflow structure.
  • ⚡ Sets foundation for expanding automation around local blockchain testing and documentation delivery.

Next Steps

  • Add implementations for the new targets (anvil, anvil-fork, anvil-polygon, docs, docs-serve) if not already defined elsewhere in the makefile.
  • Consider extending docs-serve with live reload for smoother contributor workflows.

@0xRiz0 0xRiz0 self-assigned this Sep 25, 2025
@0xRiz0 0xRiz0 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 25, 2025
@0xRiz0 0xRiz0 merged commit d8d5053 into main Sep 25, 2025
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant