Skip to content

[3D Printing] Documentation Update for website#190

Merged
jamespilgrim merged 2 commits into
PiTracLM:mainfrom
stefanferry:main
Apr 1, 2026
Merged

[3D Printing] Documentation Update for website#190
jamespilgrim merged 2 commits into
PiTracLM:mainfrom
stefanferry:main

Conversation

@stefanferry
Copy link
Copy Markdown
Contributor

Description

The V3 enclosure documentation is not visible on the PiTrac website
Legacy V2-connector board carrier might collide with ethernet cable

What does this PR do?

Added headers in the .md files within docs/hardware to be compatible with just-the-docs
Changed legacy V2-connector board carrier for to avoid colision with ethernet cable

Why is this change needed?

more transparent documentation

Related Issue(s)

Closes #

Changes Made

  • updated several .md files with header information
  • changed ConnectorBoardv2-Mod_Carrier mosfet board position more to the left

Testing Performed

function confirmed in hardware

Test Environment

  • Pi Model:
  • Camera Type:
  • OS Version:
  • Installation Method:

Test Results

  • pitrac test hardware passes
  • pitrac test camera passes (if camera-related)
  • pitrac test pulse passes (if strobe-related)
  • Simulator integration tested with:
  • Performance metrics:

Test Commands Run

# Paste the actual commands and output

Performance Impact

  • Before:
  • After:
  • Impact:

Breaking Changes

  • This PR includes breaking changes
    • What breaks:
    • Migration steps:

Dependencies

  • No new dependencies
  • [ ] New dependencies added:

  • [ ] Updated dependencies:

Hardware Compatibility

  • Tested on Pi 5
  • Tested on Pi 4
  • Tested with single Pi setup
  • Tested with dual Pi setup

Documentation

  • No documentation needed
  • Documentation updated in this PR
  • Documentation PR to follow
  • Updated relevant sections:
    • README
    • Hardware guide
    • Software guide
    • Troubleshooting guide

Screenshots/Videos

AI (Vibe-Coded) Content Description

No AI use

Checklist

Code Quality

  • Code follows existing patterns and conventions
  • No unnecessary comments added
  • Error handling implemented appropriately

Build & Test

  • Successfully builds with ./packaging/build.sh build
  • All existing tests pass
  • New tests added for new functionality
  • Tested on actual Raspberry Pi hardware (not just CI)

Submission Requirements

  • Commits squashed if needed (git rebase -i HEAD~n)
  • CLA signed
  • PR title follows format: [PR TYPE] Brief description
  • Branch is up-to-date with main

Additional Context


Copy link
Copy Markdown
Collaborator

@jamespilgrim jamespilgrim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Stefan.

@jamespilgrim jamespilgrim merged commit dd877d7 into PiTracLM:main Apr 1, 2026
2 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants