microsoft / microsoft/pxt-maker

Docs Update - Custom Boards

Open
#282 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
130
Forks
90
Avg merge
1d 14h
Merged PRs (30d)
1

Description

Hi there,

I'll take ownership of this one and formalise it a bit better.

This is relating to adding custom boards with extended name sets.

@peterpanstechland message:
in order to get the dts.ts.d autogenerated, you need to(this is what i did):

pxt clean
rm -Rf node_modules/pxt-common-packages
pxt link ../pxt-common-packages  (this is after you have modified the configkeys.h)
pxt buidaldts (if you get some error about missing file in the built folder, I got this error when i did this, and then I tried run "pxt builddaldts" in the pxt-maker/node_modules/pxt-common-package/ first, then run this command again in the pxt-maker folder)
this should update the dts.ts.d files.

Short Version (updated):

pxt clean
rm -Rf node_modules/pxt-common-packages
pxt link ../pxt-common-packages
pxt builddaldts
pxt serve --localbuild

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the issue's short-version command sequence for adding custom boards with extended name sets. Formalize the documented workflow around pxt clean, pxt link, pxt builddaldts, and pxt serve --localbuild; done means the custom-board process is clearly documented, though no documentation file is named here.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.