Skip to content

Curio PDP docs: curio has the meat, other places have pointers #1342

Description

@BigLep

Context

We need to close the loop on where Curio / PDP SP documentation lives and get the current documentation work out of limbo.

The current situation is creating repeated Slack discussion and stale cross-repo documentation:

  • docs(pdp): add Enable HTTPS for PDP guide filecoin-docs#2470 has been open for more than a week and contains PDP SP guidance that would already have been useful to at least one endorsed FOC SP.
  • docs: add Storage Provider Guides section FilOzone/synapse-sdk#862 referenced the outdated pdpv0 branch, which illustrates the drift problem when Curio operational guidance lives outside the Curio repo.
  • In the July 1 FOC WG Slack thread, Beck asked whether Curio maintainers agree that older filecoin-docs material should be integrated into Curio docs, since planned PDP installation / product improvements may change much of the tutorial content.

Current understanding

From the June 30 FOC WG discussion, my understanding is:

  • Detailed Curio installation, operation, PDP, and SP documentation should live in the Curio documentation.
  • filecoin.io and filecoin.cloud should provide a concise, high-level SP onboarding guide.
  • Those high-level guides should link directly to the relevant Curio docs.
  • Filecoin / FOC documentation should remain a thin entry or pointer layer.
  • Detailed content should not be duplicated across multiple sites because it will drift and become stale.

This issue is intended to track the Curio-side work needed to make that real.

Problems

  • PRs are being opened in non-Curio repos with detailed Curio/PDP content.
  • Those PRs can contain stale or soon-to-be-stale implementation details.
  • Curio maintainers may not see or review the content.
  • Operators who hit advanced setup or troubleshooting cases get Slack explanations instead of maintained URLs.
  • Agent/tooling workflows are less likely to discover the relevant guidance because it is not near the Curio source.

Steve take: the plan to make PDP installation easier and move more guidance into the product is good, but it does not remove the need for discoverable documentation covering advanced usage, troubleshooting, and non-happy-path deployments.

Proposed outcome

Curio should have a maintained documentation home for PDP SP setup and operations, including enough material that external docs can link into it instead of duplicating it.

This does not need to block future UX/product improvements. The docs can evolve as Curio improves.

Done criteria

  • Curio maintainers confirm the intended documentation home for detailed PDP SP guidance.
  • Curio docs contain current PDP SP setup / operational guidance, or a clear initial page with follow-up issues for missing sections.
  • Deprecated references such as pdpv0 are removed or clearly marked as obsolete.
  • docs(pdp): add Enable HTTPS for PDP guide filecoin-docs#2470 has a clear disposition: retargeted, reduced to links, or closed.
  • Synapse SDK docs link to the Curio-owned documentation for PDP SP setup details.
  • Thin entry pages on Filecoin / FOC docs link to the Curio docs rather than duplicating detailed content.

Related links

Metadata

Metadata

Assignees

Labels

team/fs-wgItems being worked on or tracked by the "FS Working Group". See FilOzone/github-mgmt #10

Type

No type

Projects

Status
🐱 Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions