Z-Tools Portfolio Documentation

Comprehensive technical documentation for the z-tools ecosystem, including standardization guides, build infrastructure, CI/CD pipelines, and development workflows.

Overview

This documentation covers cross-project standards, infrastructure setup, packaging and distribution, and detailed development guides for the entire z-tools portfolio.


📋 Master References

Master Index

Central navigation hub for all portfolio documentation. Start here to understand the complete documentation structure and find what you need quickly.

Cross-Project Index

Overview of all z-tools projects, their relationships, and how they work together. Includes project status, version tracking, and interdependencies.


🏗️ Infrastructure & Build Systems

CI/CD Standardization Guide

Complete standardization of CI/CD pipelines across all projects

Covers:

  • GitHub Actions workflow patterns
  • Automated testing, linting, and security scanning
  • Release automation and version management
  • Multi-architecture build strategies
  • Package distribution (PyPI, Debian, Crates.io)

ARM64 Cross-Compile Guide

Build Python packages for ARM64 architecture

Covers:

  • Multi-architecture Docker setup
  • QEMU-based cross-compilation
  • Build verification on target architecture
  • ARM64-specific optimization strategies

Bootstrap Documentation

Complete project bootstrap and setup procedures

Covers:

  • Initial repository setup
  • Development environment configuration
  • Dependency management
  • Automated setup scripts

🔧 Development & Standardization

Agents Standardization Guide

OpenCode agent documentation standards and best practices

Covers:

  • AGENTS.md file structure
  • Agent documentation patterns
  • Project status tracking
  • Version synchronization

Crates.io Analysis

Comprehensive analysis of Rust publishing to Crates.io

Covers:

  • Crates.io account setup
  • Publishing workflow
  • Version management
  • Dependency specifications
  • Security and maintenance

Crates.io Quick Reference

Quick reference guide for Crates.io publishing

Covers:

  • Quick start checklist
  • Common commands
  • Troubleshooting tips
  • Publishing checklist

🛠️ Repository Tools

Repository Tool Guide

Complete guide to the multi-project repository tool

Covers:

  • Installation and setup
  • Basic commands and workflows
  • Configuration options
  • Integration with development workflow

Repository Tool Tutorial

Step-by-step tutorial for common repository tasks

Covers:

  • Getting started scenarios
  • Common workflows (commit, push, pull, sync)
  • Multi-project operations
  • Best practices and tips

Repository Tool Advanced Guide

Advanced repository tool features and customization

Covers:

  • Advanced command options
  • Custom scripting and automation
  • Integration with CI/CD
  • Performance optimization

README Repository Tool

README documentation for the repository tool

Covers:

  • Feature overview
  • Installation methods
  • Quick start examples
  • Configuration details

📚 How to Use This Documentation

For New Contributors

  1. Start with the Master Index
  2. Review Cross-Project Index to understand project relationships
  3. Follow the Bootstrap Documentation to set up your environment

For Infrastructure Setup

  1. Review CI/CD Standardization Guide for pipeline patterns
  2. Check ARM64 Cross-Compile Guide if building multi-arch packages

For Publishing & Releases

  1. Follow Crates.io Analysis for comprehensive overview
  2. Use Crates.io Quick Reference for quick lookup

For Multi-Project Development

  1. Install and configure using Repository Tool Guide
  2. Follow tutorials in Repository Tool Tutorial
  3. Explore advanced features in Repository Tool Advanced Guide

📖 All Documents

Document Purpose Length
Master Index Central navigation hub Long
Cross-Project Index Project overview Medium
CI/CD Standardization Guide Build pipeline standards Comprehensive
ARM64 Cross-Compile Guide Multi-arch builds Medium
Bootstrap Documentation Project setup Medium
Agents Standardization Guide Agent documentation Medium
Crates.io Analysis Rust publishing Comprehensive
Crates.io Quick Reference Publishing quick ref Short
Repository Tool Guide Tool complete guide Comprehensive
Repository Tool Tutorial Tutorial walkthrough Long
Repository Tool Advanced Advanced features Medium
README Repository Tool Tool README Short

Looking for something specific?


📝 Contributing to Documentation

Found an issue or want to improve the documentation?

  1. Visit the GitHub repository
  2. Edit the documentation files in docs/_portfolio-docs/
  3. Submit a pull request with your improvements

Last updated: April 16, 2026