Add a GUIDE.md for documentation #115
Open
+417
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rreichenbach
approved these changes
Jan 25, 2026
Collaborator
rreichenbach
left a comment
rreichenbach
left a comment
There was a problem hiding this comment.
Helpful stuff in there. Added a few suggestions.
|
|
||
| ```bash | ||
| # Restart piStomp service | ||
| sudo systemctl restart mod-ala-pi-stomp |
Collaborator
There was a problem hiding this comment.
would prefer mention of the convenience aliases here:
ps-restart
ps-run
ps-stop
| scp modalapi/*.py pistomp@pistomp.local:/home/pistomp/pi-stomp/modalapi/ | ||
|
|
||
| # 3. Restart the service (Python takes care of re-creating __pycache__ files) | ||
| ssh pistomp@pistomp.local "sudo systemctl restart mod-ala-pi-stomp" |
| ## Deployment Workflow | ||
|
|
||
| ```bash | ||
| # 1. Edit files locally in /Users/cam/dev/pi-stomp/ |
Collaborator
There was a problem hiding this comment.
Could also mention that the filesystem can be mounted remotely and edited in place using:
sshfs pistomp@pistomp.local:/home/pistomp <LOCAL_DIR> -o defer_permissions -o volname=Server
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to https://treefallsound.com/wiki/doku.php?id=developers_guide but inside of the repo as Markdown so it can be easily used by humans and coding assistants alike.