books: user-book for cuprated 0.0.2
#402
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
A-books
hinto-janai
commented
Mar 21, 2025
| **⚠️ This project is still in development; do NOT use `cuprated` for any serious purposes ⚠️** | ||
|
|
||
| `cuprated` is fine to run for casual purposes and has a similar attack surface to other network connected services. | ||
| `cuprated` is fine to run for non-serious purposes and has a similar attack surface to other network connected services. |
There was a problem hiding this comment.
@SyntheticBird45 I used casual here as the opposite of serious, although looking back I agree that better phrasing could be used, any suggestions?
There was a problem hiding this comment.
Sorry, I don't see any other suggestion. non-serious may convey a negative but is straight to the point.
17 tasks
hinto-janai
commented
Apr 8, 2025
Comment on lines
+12
to
+61
| /// # Documentation | ||
| /// Consider using the following style when adding documentation: | ||
| /// | ||
| /// ```rust | ||
| /// struct Config { | ||
| /// /// BRIEF DESCRIPTION. | ||
| /// /// | ||
| /// /// (optional) LONGER DESCRIPTION. | ||
| // /// | ||
| /// /// Type | (optional) FIELD TYPE | ||
| /// /// Valid values | EXPRESSION REPRESENTING VALID VALUES | ||
| /// /// Examples | (optional) A FEW EXAMPLE VALUES | ||
| /// field: (), | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// For example: | ||
| /// ```rust | ||
| /// struct Config { | ||
| /// /// Enable/disable fast sync. | ||
| /// /// | ||
| /// /// Fast sync skips verification of old blocks by | ||
| /// /// comparing block hashes to a built-in hash file, | ||
| /// /// disabling this will significantly increase sync time. | ||
| /// /// New blocks are still fully validated. | ||
| /// /// | ||
| /// /// Type | boolean | ||
| /// /// Valid values | true, false | ||
| /// fast_sync: bool, | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// Language for types: | ||
| /// | ||
| /// | Rust type | Wording used in user-book | | ||
| /// |--------------|---------------------------| | ||
| /// | bool | boolean | ||
| /// | u{8-64} | Number | ||
| /// | i{8-64} | Signed number | ||
| /// | f{32,64} | Floating point number | ||
| /// | str, String | String | ||
| /// | enum, struct | `DataStructureName` (e.g. `Duration`) or $DESCRIPTION (e.g. `IP address`) | ||
| /// | ||
| /// If some fields are redundant or unnecessary, do not add them. | ||
| /// | ||
| /// # Field documentation length | ||
| /// In order to prevent wrapping/scrollbars in the user book and in editors, | ||
| /// add newlines when a documentation line crosses ~70 characters, around this long: | ||
| /// | ||
| /// `----------------------------------------------------------------------` |
There was a problem hiding this comment.
This PR adds docs to the config similar to #304 (comment).
I do have diffs to add these sections to the book, but it means we'll have to maintain two sets of key/value pairs + docs, so I think we should put all this info in the config since it's now automated. Since the user-book shows the config, it acts as the docs, not as pretty but more practical.
There was a problem hiding this comment.
I did try think about ways to make it prettier but yeah decided on just dumping the raw toml in the user book. The practicality justifies the looks.
books/user/src/cli.md
Outdated
Comment on lines
19
to
35
| ## `--version` | ||
| The `--version` flag outputs the following info in JSON. | ||
|
|
||
| | Field | Type | Description | | ||
| |-------------------------|--------|-------------| | ||
| | `major_version` | Number | Major version of `cuprated` | | ||
| | `minor_version` | Number | Minor version of `cuprated` | | ||
| | `patch_version` | Number | Patch version of `cuprated` | | ||
| | `rpc_major_version` | Number | Major RPC version (follows `monerod`) | | ||
| | `rpc_minor_version` | Number | minor RPC version (follows `monerod`) | | ||
| | `rpc_version` | Number | RPC version (follows `monerod`) | | ||
| | `hardfork` | Number | Current hardfork version | | ||
| | `blockchain_db_version` | Number | Blockchain database version (separate from `monerod`) | | ||
| | `semantic_version` | String | Semantic version of `cuprated` | | ||
| | `build` | String | Build of `cuprated`, either `debug` or `release` | | ||
| | `commit` | String | `git` commit hash of `cuprated` | | ||
| | `killswitch_timestamp` | Number | Timestamp at which `cuprated`'s killswitch activates | |
| | Target | Notes | | ||
| |-----------------------------|--------| | ||
| | `x86_64-pc-windows-msvc` | x64 Windows (MSVC, Windows Server 2022+) | ||
| | `x86_64-apple-darwin` | x64 macOS |
There was a problem hiding this comment.
Mistake, this was in the wrong section.
Boog900
approved these changes
Apr 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Adds information covering changes for
cuprated v0.0.2to the User Book.Closes #411.