clockworklabs / clockworklabs/SpacetimeDB

Better documentation: module names are global

Open
#3,911 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
25.2k
Forks
1.1k
Avg merge
2d 7h
Merged PRs (30d)
46

Description

Minor suggestion:

For this command: spacetime publish -s maincloud my-cool-module please clarify that the module names are global, so you have to use something unique. Otherwise you get 401 or 403 errors.

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 with the documentation for the spacetime publish -s maincloud my-cool-module command. Clarify that module names are global and must be unique, and explain that non-unique names can produce 401 or 403 errors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.