dxos / gravity

System testing frameworks.

GNU Affero General Public License v3.0

1 stars 1 forks source link

Docs cleanup notes #52

Open alexwykoff opened 3 years ago

alexwykoff commented 3 years ago

General

[ ] Use a spellchecker before submitting any doc PRs

TODOS

docs/content/guides/writing-code.md

Writing Code

[ ] TODO(burdon): Clean-up.
[ ] TODO(burdon): Lint instructions.
Misc
- [ ] TODO(burdon): null vs undefined
- [ ] TODO(burdon): async
- [ ] TODO(burdon): Number clauses and use as reference with PRs.
  ((This is dangling without a header))
- [ ] TODO(burdon): Save PyCharm style settings. <-- Is this still an issue?

docs/content/devops/git-repos.md

Set-up

[ ] TODO(burdon): Template (or example) repo?
Branches
[ ] TODO(burdon): Add example flow (echo, client, react-client, tasks-app, gravity).
Tests
[ ] TODO(burdon): Reference GH workflow assets.
Github Workflows and Actions
[ ] TODO(burdon): Standarize actions (tests, coverage, release, etc.)
[ ] TODO(burdon): Reference sample project with canonical workflow definitions (e.g., @dxos/echo?)
Badges
[ ] TODO(burdon): Reference sample project with canonical workflow definitions (e.g., @dxos/echo?)

docs/content/devops/development-guide.md

[ ] TODO(burdon): Reference @dxos/version-check.

docs/content/devops/tools/verdaccio/index.md

[ ] TODO(burdon): Why was 5736 chosen and link to registry of used port numbers. The docs reference 4873.