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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add "Session Windows & On-Chain Parameters" section to claim/proof/lifecycle docs #632

Merged
merged 11 commits into from
Jun 28, 2024
Merged

[Docs] Add "Session Windows & On-Chain Parameters" section to claim/proof/lifecycle docs #632

merged 11 commits into from
Jun 28, 2024

Conversation

bryanchriswhite
Copy link
Contributor

@bryanchriswhite bryanchriswhite commented Jun 24, 2024 •
edited
Loading

Issue

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

Documentation changes (only if making doc changes)

  • make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • See quickstart guide for instructions

PR Testing (only if making code changes)

  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
    • THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
    • Optionally run make trigger_ci if you want to re-trigger tests without any code changes
    • If tests fail, try re-running failed tests only using the GitHub UI as shown here

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@bryanchriswhite bryanchriswhite added the documentation Improvements or additions to documentation label Jun 24, 2024
@bryanchriswhite bryanchriswhite self-assigned this Jun 24, 2024
bryanchriswhite
bryanchriswhite commented Jun 25, 2024
View reviewed changes
docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md
@@ -19,13 +19,11 @@ to all readers.
- [Session Duration](#session-duration)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm noticing that the adding a table of contents to the contents seems redundant as docusaurus builds one in the sidebar on the right.

image

Copy link
Member

Choose a reason for hiding this comment

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

I still think it's useful when rendering locally.

@bryanchriswhite bryanchriswhite marked this pull request as ready for review June 25, 2024 06:41
@bryanchriswhite bryanchriswhite mentioned this pull request Jun 25, 2024
Merged
14 tasks
red-0ne
red-0ne reviewed Jun 28, 2024
View reviewed changes
Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

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

Very good and precise doc.

Although I have some comments that I want to be clarified.

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md Outdated Show resolved Hide resolved
docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md Outdated Show resolved Hide resolved
@bryanchriswhite @red-0ne
chore: review feedback improvements
a9d3c2f 
Co-authored-by: Redouane Lakrache <[email protected]>
red-0ne
red-0ne approved these changes Jun 28, 2024
View reviewed changes
Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

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

🔥

@bryanchriswhite bryanchriswhite merged commit d1f4f42 into main Jun 28, 2024
11 of 12 checks passed
@bryanchriswhite bryanchriswhite deleted the issues/586/docs/claim-proof-lifecycle2 branch June 28, 2024 21:48
bryanchriswhite added a commit that referenced this pull request Jun 28, 2024
@bryanchriswhite
Merge remote-tracking branch 'pokt/main' into issues/580/events/refac…
1e51c1d 
…tor+feat

* pokt/main:
  [On-Chain] Refactor `grace_period_end_offset_blocks` as a `shared` module param (#628)
  [Docs] Add "Session Windows & On-Chain Parameters" section to claim/proof/lifecycle docs (#632)
@bryanchriswhite bryanchriswhite linked an issue Jul 1, 2024 that may be closed by this pull request
[Docs] RPC session life-cycle #464
Closed
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@red-0ne red-0ne red-0ne approved these changes

@Olshansk Olshansk Awaiting requested review from Olshansk

Assignees

@bryanchriswhite bryanchriswhite

Labels
documentation Improvements or additions to documentation
Projects
Shannon
Status: ✅ Done
Milestone
Shannon Beta TestNet Launch
Development

Successfully merging this pull request may close these issues.

[Docs] RPC session life-cycle
3 participants
@bryanchriswhite @red-0ne @Olshansk