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

rebuild CLI URLs dynamically for ever platform, point to latest release #1300

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Nov 5, 2024


Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The pull request updates documentation and simplifies CLI download instructions across different platforms. It finalizes the Node and NodeSet documentation, ensuring users have full configuration parameters and examples at their disposal. Additionally, it aims to make the CLI more accessible by providing direct download links for various operating systems.

What

  • book/src/framework/components/chainlink/node.md
    • Added full configuration parameters for Node with detailed explanations and default values.
    • Included usage example in Go, demonstrating how to use the configuration in tests.
  • book/src/framework/components/chainlink/nodeset.md
    • Introduced full configuration parameters for NodeSet, similar to Node documentation.
    • Added a configuration example for a required Blockchain component.
    • Updated the usage section with a more comprehensive Go example, including blockchain and mock data provider setup.
  • book/src/framework/getting_started.md
    • Updated the section to add the framework package instead of pulling the framework, reflecting a more streamlined setup process.
    • Replaced the CLI installation steps with download links for specific OS versions, making it easier for users to get started without navigating through the repository.
  • framework/.changeset/v0.1.9.md
    • Created a new changeset file indicating the simplification of CLI download instructions and the finalization of Node and NodeSet documentation.

These changes ensure users have a clearer understanding of how to configure and utilize Nodes and NodeSets within the testing framework. By providing direct CLI download links for various operating systems, the setup process becomes more straightforward, encouraging more developers to adopt and contribute to the framework.

@cl-sonarqube-production
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@skudasov skudasov merged commit 258e5a7 into main Nov 5, 2024
40 of 43 checks passed
@skudasov skudasov deleted the cli-docs-more-components branch November 5, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants