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

feat: Update documentation with detailed logging configuration #19

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

huitseeker
Copy link
Member

@huitseeker huitseeker commented Oct 25, 2024

After argumentcomputer/sphinx#193

  • Resolve a typo error in instructions set for Rust installation
  • Enhance README.md file with extensive details about the two logging systems used in our software - Rust's tokio-tracing and Go for FFI calls
  • Provide complete direction to users on methods to setup a unified log level for both logging systems
  • Enumerate all applicable log levels: error, warn, info, debug, and trace for user reference.

- Resolve a typo error in instructions set for Rust installation
- Enhance README.md file with extensive details about the two logging systems used in our software - Rust's `tokio-tracing` and Go for FFI calls
- Provide complete direction to users on methods to setup a unified log level for both logging systems
- Enumerate all applicable log levels: error, warn, info, debug, and trace for user reference.
Copy link
Member

@wwared wwared left a comment

Choose a reason for hiding this comment

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

Minor nit below (since SP1_GO_LOG being unset defaults to info level, we should explicitly document how to turn it off)

README.md Outdated Show resolved Hide resolved
Co-authored-by: wwared <[email protected]>
@huitseeker huitseeker merged commit aee6fa9 into main Oct 25, 2024
2 checks passed
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