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

Let's update the spec! #1325

Open
ianconsolata opened this issue Sep 27, 2023 · 1 comment
Open

Let's update the spec! #1325

ianconsolata opened this issue Sep 27, 2023 · 1 comment

Comments

@ianconsolata
Copy link
Collaborator

Suggested next steps from the Let's Update the Spec! session at Fil Dev Summit Iceland:

  • Spec and an accompanying conformance test suite
    • keeps the standard and implementers honest and in sync
    • example: web platform tests -> every browser engine runs the test suite in CI
    • enables can I use, creates competition between browser vendors, there are always intersection issues, as a user you can only use the intersection of the features in all implementations
  • Offer help! How can we decentralized spec maintenance?
  • Maybe FIP editors / authors / automated process should make sure that appropriate FIPs have relevant changes to the Spec
  • Define what should actually be included in the Filecoin spec, and whether there are subspecs that can be factored out.
    • Modularity allows folks to track updates much more easily.
      • downside is that you need link management to keep the interlinks up to date.
  • Should things like market implementation, data onboarding clients, and other protocols be included?
  • Crosslink the spec and the code implementation -- add comments in code to relevant spec sections, and add links to code in relevant specs section.
    • Subprojects like builtin-actors should have clear documentation, and link into the spec. It's not only lotus where the implementation lives.
  • Don't hesitate to drop things that are really obvious. if it's not needed for documentation purposes because people know it, it can probably be trimmed down so it's more modular.

Link to other places where documentation is happening:

Action plans:

  • @ianconsolata to make issues for each FIP that requires spec updates
@ianconsolata
Copy link
Collaborator Author

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

No branches or pull requests

1 participant