docs: overhaul all #585
Merged
docs: overhaul all #585
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
This was referenced Sep 11, 2024
willcl-ark
reviewed
Sep 11, 2024
docs/logging_monitoring.md
Outdated
| ``` | ||
|
|
||
| The data can be retrieved from the Prometheus exporter on port `9332`, example: | ||
| The data can be retrieved firectly from the Prometheus exporter container in the tank pod via port `9332`, example: |
| `uv` can also run tools (like `ruff`) without external installation, simply run `uvx ruff check .` or `uvx ruff format .` to use a uv-managed format/lint on the project. | ||
|
|
||
| ## Release process |
There was a problem hiding this comment.
Think this is better in a dedicated document? It's not really developer notes or even relevant for general contributors.
There was a problem hiding this comment.
only if you insist. i prefer having all the meta stuff in one place whether its for new contributors or us old salts.
docs/logging_monitoring.md
Outdated
|
|
||
| Example: | ||
|
|
||
| ```sh | ||
| $ warnet bitcoin debug-log 0 | ||
| $ warnet bitcoin debug-log tank=0000 |
docs/warnet.md
Outdated
| and additionally include 7 extra random outbounds per node. Include lightning | ||
| channels and their policies as well. | ||
| Returns XML file as string with or without --outfile option. | ||
| and additionally include 7 extra random outbounds per node. Include lightning |
There was a problem hiding this comment.
did apidocs.py add this weird whitespace?
There was a problem hiding this comment.
i suppose it did, im just going to remove the entire command since its not implemented anyway
|
addressed some comments |
pinheadmz
force-pushed
the
docs-sep11
branch
from
e9bb274 to
7c2a899
Compare
6 tasks
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsNo conflicts as of last run. |
Merged
pinheadmz
force-pushed
the
docs-sep11
branch
from
7c2a899 to
ca35234
Compare
|
rebased on main after #588 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
More updates since the helm refactor. Removed a few references to
rpc-0or "the server", removed irrelevant files like lightning. Combined all developer notes into one file. Rebuilt cli API docs. Major changes to logging infrastructure. Only functional change is removing the default path for snapshot export.