Skip to content

docs: update /v2 API docs to make clear the impact if F3 isn't finalizing or is stalled#13161

Merged
BigLep merged 5 commits intomasterfrom
docs/v2-apis-note-about-f3-finalization
Jun 9, 2025
Merged

docs: update /v2 API docs to make clear the impact if F3 isn't finalizing or is stalled#13161
BigLep merged 5 commits intomasterfrom
docs/v2-apis-note-about-f3-finalization

Conversation

@BigLep
Copy link
Member

@BigLep BigLep commented Jun 6, 2025

This lack of clarification in the documentation was identified when creating docs for RPC providers and exchanges.

…izing or is stalled.

This lack of clarification in the documentation was identified when creating docs for RPC providers and exchanges.
@github-project-automation github-project-automation bot moved this to 📌 Triage in FilOz Jun 6, 2025
@github-project-automation github-project-automation bot moved this to Todo in F3 Jun 6, 2025
@BigLep BigLep moved this from Todo to In review in F3 Jun 6, 2025
@BigLep BigLep self-assigned this Jun 6, 2025
@BigLep BigLep requested review from masih and rjan90 June 6, 2025 18:17
@BigLep BigLep marked this pull request as ready for review June 6, 2025 18:36
Copilot AI review requested due to automatic review settings June 6, 2025 18:36
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-project-automation github-project-automation bot moved this from 📌 Triage to ⌨️ In Progress in FilOz Jun 6, 2025
@github-project-automation github-project-automation bot moved this from In review to In progress in F3 Jun 6, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR clarifies how the /v2 APIs behave when Filecoin Fast Finality (F3) is not finalizing or falls behind EC finality, updating documentation and table of contents accordingly.

  • Adds new FAQ sections and ToC entries about F3 non-finalization and EC fallback
  • Expands the finalized tag description and flowchart to illustrate fallback logic
  • Fixes minor markdown and punctuation inconsistencies

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md Clarified F3 fallback behavior, updated ToC and flowchart, tweaked copy
documentation/en/api-experimental-user-facing-v2-docs/CLAUDE.md Updated related-code file descriptions
Comments suppressed due to low confidence (1)

documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md:10

  • [nitpick] The phrase 'if last finalized tipset is more than EC-finalized tipsets in the past' is ambiguous; consider rephrasing to clearly state the condition, for example: 'if the F3-finalized tipset is older than the EC-finalized tipset by more than the EC finality threshold.'
2025-06-06: Updated to make clear the impact on the APIs if F3 isn't finalizing or if last finalized tipset is more than EC-finalized tipsets in the past. This was reviewed in [PR #13161](https://github.com/filecoin-project/lotus/pull/13161).

Copy link
Contributor

@rjan90 rjan90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typos caught by the copilot review that would be nice to commit, but else it looks good to me!

@BigLep BigLep added the skip/changelog This change does not require CHANGELOG.md update label Jun 6, 2025
@BigLep BigLep changed the title docs: Updated /v2 API docs to make clear the impact if F3 isn't finalizing or is stalled. docs: update /v2 API docs to make clear the impact if F3 isn't finalizing or is stalled Jun 6, 2025
@github-actions github-actions bot dismissed their stale review June 6, 2025 19:02

PR title now matches the required format.

BigLep and others added 3 commits June 6, 2025 12:02
…xperimental.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…xperimental.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-project-automation github-project-automation bot moved this from ⌨️ In Progress to ✔️ Approved by reviewer in FilOz Jun 9, 2025
@github-project-automation github-project-automation bot moved this from In progress to In review in F3 Jun 9, 2025
@BigLep BigLep merged commit 5e8a8f3 into master Jun 9, 2025
95 checks passed
@BigLep BigLep deleted the docs/v2-apis-note-about-f3-finalization branch June 9, 2025 14:23
@github-project-automation github-project-automation bot moved this from ✔️ Approved by reviewer to 🎉 Done in FilOz Jun 9, 2025
@github-project-automation github-project-automation bot moved this from In review to Done in F3 Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip/changelog This change does not require CHANGELOG.md update

Projects

Status: Done
Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

4 participants