Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meadowphysics Docs update #8

Merged
merged 11 commits into from Jan 29, 2018
Merged

Meadowphysics Docs update #8

merged 11 commits into from Jan 29, 2018

Conversation

@cmcavoy
Copy link
Contributor

@cmcavoy cmcavoy commented Nov 6, 2017

Updates to the MP module docs based on 2.1 changes. This branch isn't ready to be merged, it doesn't have images and most likely needs some editing / word-smithing. Several parts are cut and pasted from lines threads, so might need some voice consolidation / blending.

I thought a PR would help reviewers.

@cmcavoy cmcavoy requested a review from tehn Nov 9, 2017
@tehn
Copy link
Member

@tehn tehn commented Nov 9, 2017

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Nov 9, 2017

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Nov 27, 2017

Quick update, I have the illustrator files necessary to finish this. Will work with my graphic designer wife to finish this up. No ETA, but would like to be done sooner than later.

@tehn
Copy link
Member

@tehn tehn commented Jan 25, 2018

checking in on this! how's it going?

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 25, 2018

Hello!

I'm going to add the illustrator templates to this PR, that's the blocker for me. I think the text is all ready to go (could use another set of eyes to confirm), just need the graphics. I haven't been able to get time from mrs. @cmcavoy to do the updates. From my POV, if the text is ok - just release that and then see if we can get a designer volunteer on lines to finish up the graphics?

cmcavoy added 2 commits Jan 25, 2018
…ibuted by Piotr Szyhalski (@laborcamp) and are added here with his permission.
…c needs here. Also made a few grammar changes. I still don't trust my ability to use effect and affect properly, so merger beware.
@cmcavoy cmcavoy changed the title [WIP do not merge] Meadowphysics Docs update Meadowphysics Docs update Jan 25, 2018
@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 25, 2018

@tehn looks like the images from the ansible docs are ok to use here. None of the ones I pulled over include the ability to choose notes / cv out, so this is good to go. I cleaned up a bit of the language on a re-read.

I think this is ready to merge.

@tehn
Copy link
Member

@tehn tehn commented Jan 25, 2018

spectacular, thank you.

i'm going to copy v1 to a backup file to link it as some people may have/prefer the old version. will get this merged after i do that.

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 26, 2018

The 1.x code isn't tagged in the MP repo. If that's possible, can't hurt. Definitely a different approach than 2.1.

@tehn
Copy link
Member

@tehn tehn commented Jan 26, 2018

i’ll find the final commit of 1.x

@tehn
Copy link
Member

@tehn tehn commented Jan 29, 2018

i've located the v1 firmware commit, noted it in the newly-saved mp1.md.

can you fix this merge? also we don't need the .zip file included.

@tehn
tehn approved these changes Jan 29, 2018
@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 29, 2018

Made a change to resolve the merge issue that may break links. I moved the 1.x MP docs into a subfolder called MP1 and 2.x into MP2. I changed the permalink tag at the top of each index, but I'm not sure what links to these pages, so it might be an issue. @tehn your last commit deleted the meadowphysics/index.md...not sure if that was your intention. Do you want to have two folders (the way I have it now?) or were you just trying to save the docs generally? Either way works...if you don't like this split into two folders, I can move the MP2 docs back into /meadowphysics.

@tehn
Copy link
Member

@tehn tehn commented Jan 29, 2018

i'd keep v2 in /meadowphysics/ and v1 be its own subfolder, thanks.

@tehn
Copy link
Member

@tehn tehn commented Jan 29, 2018

updated comment, sorry. v1 should be a subfolder. current version (v2) stays in root.

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 29, 2018

Got it...i'll make that change in a bit.

@cmcavoy
Copy link
Contributor Author

@cmcavoy cmcavoy commented Jan 29, 2018

Ok, updates made.

@tehn tehn merged commit 86c1601 into monome:master Jan 29, 2018
@tehn
Copy link
Member

@tehn tehn commented Jan 29, 2018

amazing!! thank you!

@cmcavoy cmcavoy deleted the cmcavoy:MP_2.1_docs branch Jan 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants