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

[LOW PRIORITY] chore: Improve liveslots-related types and documentation #7265

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

gibson042
Copy link
Member

Description

Addressing some incidental issues noticed as part of #7244:

  • Fix a stale setup-style example
  • Clarify the explanations of buildRootObject vs. setup
  • Improve type definitions

Security Considerations

n/a

Scaling Considerations

n/a

Documentation Considerations

packages/SwingSet/README.md is quite stale, and content in packages/SwingSet/docs/static-vats.md duplicates that but seems like it would be better placed there. Should this PR include such a move?

Testing Considerations

n/a

@gibson042 gibson042 requested a review from warner March 29, 2023 16:30
@gibson042 gibson042 force-pushed the 2023-03-cleanup-liveslots branch from eaa8d2f to 242670d Compare March 29, 2023 19:38
@warner
Copy link
Member

warner commented Jul 23, 2024

hm, I think README.md should be restricted to things like "what is swingset" and "why would I want to use it"/"what problems does it solve"/"what can it do for me" and "how are the docs organized", and leave things like "how do I write a vat" to more specific documentation

"how do I write a host application" and "how do I create a kernel/controller" should go in their own document, somewhere towards the beginning of the table of contents that should be in README.md

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