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

[Docs] Minor improvements to adding_params.md #623

Merged
merged 13 commits into from
Jun 20, 2024

Conversation

Olshansk
Copy link
Member

Summary

The default list of docusaurus syntax highlighting did not include some (e.g. makefile, gherkin, json) languages that we are using.

These are available in the complete list but simply had to be enabled in the config.

Also, minor edits & nits for readability.

Type of change

Select one or more:

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

Testing

  • make docusaurus_start; only needed if you make doc changes

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Jun 18, 2024
@Olshansk Olshansk requested a review from bryanchriswhite June 18, 2024 20:56
@Olshansk Olshansk self-assigned this Jun 18, 2024
@Olshansk Olshansk added this to the Shannon Beta TestNet Launch milestone Jun 18, 2024
Copy link

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

You may need to run make trigger_ci to submit an empty commit that'll trigger the tests.

GCP workloads (requires changing the namespace to 623)
Grafana network dashboard for devnet-issue-{issue-id}

@github-actions github-actions bot added devnet push-image CI related - pushes images to ghcr.io labels Jun 19, 2024
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

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

I added some suggestions for a bit more detail in a few places. I just dog-fooded this while putting #628 together and found some missing steps. 🦾

@Olshansk Olshansk requested a review from bryanchriswhite June 20, 2024 20:26
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

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

🚀

@Olshansk Olshansk merged commit e7dad9b into main Jun 20, 2024
12 checks passed
@Olshansk Olshansk deleted the improve_docs_heighlighting branch June 20, 2024 21:09
bryanchriswhite added a commit that referenced this pull request Jun 26, 2024
…02/refactor/relayminer

* pokt/issues/402/feat/rng:
  [Code Health] refactor: tx hash encoding (#617)
  [Docs] Relay session & claim/proof diagrams (#478)
  Empty commit
  [Code Health] refactor: block query client interface (#616)
  [TODO] chore: cleanup done TODOs (#627)
  [TODOs] chore: cleanup validate session ID TODOs (#608)
  [LocalNet] Switch to CosmosSDK defaults (#609)
  [Relay Mining] Emit events and refactor test helpers (#610)
  [Docs] Minor improvements to `adding_params.md` (#623)
  [Telemetry] chore: add probabilistic proof telemetry (#605)
bryanchriswhite added a commit that referenced this pull request Jun 27, 2024
…aim-proof-distribution

* issues/402/refactor/relayminer: (21 commits)
  fix: unflake and speed up tests
  chore: speed up & improve tests
  chore: update comments
  chore: simplify
  [E2E] Add logging output from the init-container step (#635)
  fix: failing test
  Empty commit
  [Code Health] refactor: random number generation (#618)
  chore: review improvements
  chore: review improvments
  [Code Health] refactor: tx hash encoding (#617)
  [Docs] Relay session & claim/proof diagrams (#478)
  Empty commit
  [Code Health] refactor: block query client interface (#616)
  chore: review feedback improvements
  [TODO] chore: cleanup done TODOs (#627)
  [TODOs] chore: cleanup validate session ID TODOs (#608)
  [LocalNet] Switch to CosmosSDK defaults (#609)
  [Relay Mining] Emit events and refactor test helpers (#610)
  [Docs] Minor improvements to `adding_params.md` (#623)
  ...
okdas pushed a commit that referenced this pull request Nov 14, 2024
The [default list](https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/generate-prism-languages/index.ts#L9-L23) of docusaurus syntax highlighting did not include some (e.g. `makefile`, `gherkin`, `json`) languages that we are using.

These are available in the [complete list](https://prismjs.com/#supported-languages) but simply had to be enabled in the [config](https://docusaurus.io/docs/next/markdown-features/code-blocks#supported-languages).

Also, minor edits & nits for readability.

Co-authored-by: Bryan White <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devnet devnet-test-e2e documentation Improvements or additions to documentation push-image CI related - pushes images to ghcr.io
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants