Skip to content

Re-phrase making-accessories to be more direct #205

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

Merged

Conversation

Gadgetoid
Copy link
Contributor

The "Making Accessories" page suffers from a case of the waffles;

  • makes accessory design easy - not really! 😆
  • Many micro:bit accessories - how many?
  • are designed to use an edge connector - What proportion that were "designed to" use the edge connector actually successfully pull it off?
  • some links are erroneously under the "V2" title when they relate to both versions

I have attempted to reword this page to be more direct, making truthful statements that are useful to a PCB designer and avoiding unquantifiable, fluffy statements.

One key thing that's missing from documentation around the Edge Connector (unless I missed it) is any direct link to a suitable connector part. Is there a particular reason why the Foundation is not linking to suppliers? Is there a preferred supplier that could be linked to?

Hosting and linking to a datasheet for a compatible part might be a good compromise if all else fails. EG: Here's 4ucon's connector I found on Coolcomponents - http://www.4uconnector.com/online/object/4udrawing/10156.pdf

@microbit-mark
Copy link
Contributor

Looks good. We have links to edge connectors on c72e636 including the 4uCon connector. There is also a submission button that takes you to GitHub to edit the page and add your connections. Perhaps we could reference the edge connector page and the examples better on this page.

@microbit-mark microbit-mark merged commit 6eddd17 into microbit-foundation:master Jan 18, 2021
@microbit-mark
Copy link
Contributor

Merging as the page update is good

microbit-mark added a commit that referenced this pull request Jan 29, 2021
* Squashed 'docs/' changes from ae437c7..98a73dc

98a73dc Update index.md (#264)
6eddd17 Re-phrase making-accessories to be more direct (#205)
5bd2059 Minor updates to the pyOCD entry in "read flash" page (#249)
54a568d Add link to Android source code (#259)
91f9009 Fixed typo
ba706cf Warn users blhost is advanced and unnecessary
9e3640f Update micropython.md (#257)
113df00 add other tested DAPlink versions
a2fdb3c Ignore lancaster article (#246)
5eb4672 Update action.yml (#230)
6b0ecda change case for V2 button and table element ids (#236)
7201870 remove duplicate paragraph
cc35817 update Mbed links
58fbba0 re-label new page
7649ddf remove Workbench
ab22708 Update edgeconnector.md
16f1c90 fix links
677f242 Nov2 sprint updates (#226)
c92dd07 Update latest-revision-main.md (#223)
94aff4f update APIs and editors
3d71f9d Merge branch 'uhex-page'
854577a add hex format spec link
1d5265b add details of uHex tool (#213)
a1401e3 fix links
f5464d9 Rewrite community page (#203)
09c6b6a add details of uHex tool
652023b Update BLE services file location
cd87b61 Merge branch 'master' of https://github.com/microbit-foundation/dev-docs
3229f78 update feature availibility
9cf9964 Update latest-revision-main.md (#209)
a7eb1ae Update edgeconnector.md: Fix badly rendered "V2" (#208)
6afa1e6 Correct spelling mistake (#210)
1af07f4 update CODAL info
c72e636 Brand tidy up: v1 v2 > V1 V2
3f33b0f add audio expression api
8ac53a3 update BLE profile roles
38464b4 Update Soft Device SD140 > SD113 (#198)
0f1b15d add new brand guidelines info
3d3c6ed fix links
8260131 fix links
504c6df remove link to uhex spec as it 404s
bee772f remove link to python mailing list
ce75bb4 remove duplicate MakeCode
21c6a16 update table 200mA > 190mA
9cffab0 Update info on MakeCode blocks
cc01c0f Latest updates for MakeCode and DAPLink (#193)
18ff8f7 Update hex-format.md: add missing space (#190)
af73c3c Update apps-and-examples.md: add missing space (#189)
1f7d600 Spelling mistake (#186)
b24c88f Re-phrasing bluetooth section (#181)
4007b76 Rephrase "lozenge" to "rounded rectangular" (#180)
f8ca9aa Merge pull request #179 from Gadgetoid/spelling
afe3441 Spelling and consistency tweaks
7b0e132 Merge pull request #175 from Gadgetoid/doc-consistency
ac8b131 Consistent use of whitespace and Markdown formatting
670d1f1 Remove hard linebreaks and trailing whitespace (#174)
6be457a update iOS beta instructions (#173)
1b2f2ec Update DAPLink error message (#171)
955cf1a spelling

git-subtree-dir: docs
git-subtree-split: 98a73dc

* Squashed 'docs/' changes from 98a73dc..94067ab

94067ab Update interface.md

git-subtree-dir: docs
git-subtree-split: 94067ab
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants