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

[LocalNet] Documentation for MVT/LocalNet #488

Merged
merged 10 commits into from
May 2, 2024
Merged

Conversation

okdas
Copy link
Member

@okdas okdas commented Apr 23, 2024

Summary

Filling in gaps in LocalNet documentation identified for MVT.

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

@Olshansk
Copy link
Member

@okdas Confirming that this is still not ready for review?

@okdas okdas self-assigned this Apr 25, 2024
@okdas okdas added the documentation Improvements or additions to documentation label Apr 25, 2024
@okdas
Copy link
Member Author

okdas commented Apr 25, 2024

@okdas Confirming that this is still not ready for review?

I'll mark the PR as ready for review and will request one when this is ready.

@okdas okdas marked this pull request as ready for review April 26, 2024 16:10
@okdas okdas requested a review from Olshansk April 26, 2024 16:40
@Olshansk Olshansk added this to the Shannon Collab milestone Apr 27, 2024
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

Short & simple!

@Olshansk Olshansk merged commit dcdbaa1 into main May 2, 2024
11 checks passed
bryanchriswhite added a commit that referenced this pull request May 8, 2024
* pokt/main:
  [Code Health] chore: cleanup localnet testutils (#515)
  Zero retryLimit Support in ReplayClient (#442)
  [LocalNet] Add infrastructure to run LLM inference (#508)
  [LocalNet] Documentation for MVT/LocalNet (#488)
  [GATEWAY] Makefile target added to send relays to grove gateway (#487)
  Update README
  [CI] Add GATEWAY_URL envar for e2e tests (#506)
  [Tooling] Add gateway stake/unstake/ logs (#503)
@Olshansk Olshansk deleted the dk-mvt-localnet-docs branch May 29, 2024 16:43
okdas added a commit that referenced this pull request Nov 14, 2024
Filling in gaps in LocalNet documentation identified for MVT.


Co-authored-by: Daniel Olshansky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants