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.

Sign up for GitHub

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

Jump to bottom

make sure everything in the cli is documented #2660

Closed
divagant-martian opened this issue Aug 21, 2024 · 5 comments
Closed

make sure everything in the cli is documented #2660

divagant-martian opened this issue Aug 21, 2024 · 5 comments
Assignees
@palozano
Labels
docs Improvements or additions to documentation

Comments

@divagant-martian
Copy link
Contributor

not sure if we can deny missing docs on a specific struct, but this would be the way to go. Docs become help text in the console and it's missing in a couple of places
@palozano
Copy link
Contributor

palozano commented Sep 3, 2024

Would like to contribute to this project, and this might be a good starting point? Could anyone confirm or point to a better issue?

@divagant-martian
Copy link
Contributor Author

This is a really good issue, since it might allow you to explore the public API without writing a project on top of iroh, for example. The CLI structure is defined here and everything below this structure (the types of the fields, recursively) should have docs. This does not need to happen in a single big PR, small but complete PRs are encouraged and welcome. Most likely it would look like one PR per file in https://github.com/n0-computer/iroh/tree/main/iroh-cli/src/commands so feel free to work on any (or all) if you want

@palozano
Copy link
Contributor

palozano commented Sep 3, 2024

Nice, thanks! I'll get on with it.

@b5 b5 added the docs Improvements or additions to documentation label Sep 4, 2024
@palozano palozano mentioned this issue Sep 5, 2024
Merged
4 tasks
github-merge-queue bot pushed a commit that referenced this issue Sep 5, 2024
@palozano @matheus23
docs(iroh-cli): add docs to entrypoint (#2697)
c6e2f05 
## Description

Add documentation to undocumented items in the entrypoint for the
`iroh-cli` at `iroh/iroh-cli/src/commands.rs`.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

No breaking changes.

## Notes & open questions

No additional notes.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.

---------

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com>
This was referenced Sep 5, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): udpate doctor command documentation (#2710)
93b400a 
## Description

Update documentation to `doctor` command submodule.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->
Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update authors command documentation (#2702)
2c199a0 
## Description

Update documentation to RPC's subcommand `authors`.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

The imports have been formatted to join similar `use` paths.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update console command documentation (#2705)
4964ee3 
## Description

Update documentation to `console` command.

This partially addresses #2660, and belongs to a series of PRs to
complete it

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update net command documentation (#2707)
8c321a2 
## Description

<!-- A summary of what this pull request achieves and a rough list of
changes. -->
Update documentation to `net` command.

This partially addresses #2660, and belongs to a series of PRs to
complete it

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update start command documentation (#2708)
2636be8 
## Description

<!-- A summary of what this pull request achieves and a rough list of
changes. -->
Update documentation to `start` command.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update rpc command documentation (#2711)
518d439 
## Description

<!-- A summary of what this pull request achieves and a rough list of
changes. -->
Update documentation to tags command.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->
Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update gossip command documentation (#2706)
bdaeba1 
## Description

Update documentation to `console` commands.

This partially addresses #2660, and belongs to a series of PRs to
complete it

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano
docs(iroh-cli): update tags command documentation (#2709)
7510a59 
## Description

<!-- A summary of what this pull request achieves and a rough list of
changes. -->
Update documentation to `tags` command.

This partially addresses #2660, and belongs to a series of PRs to
complete it

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano @matheus23
docs(iroh-cli): update blobs command documentation (#2704)
76b1473 
## Description

Update documentation to RPC's subcommand `blobs`.

This partially addresses #2660, and belongs to a series of PRs to
complete it

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.

---------

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com>
github-merge-queue bot pushed a commit that referenced this issue Sep 6, 2024
@palozano @matheus23
docs(iroh-cli): update docs command documentation (#2703)
7b6c974 
## Description

Update documentation to RPC's subcommand `docs`.

This partially addresses #2660, and belongs to a series of PRs to
complete it.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

Imports have been formated to be grouped.

## Change checklist

- [ ] Self-review.
- [X] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.

---------

Co-authored-by: Philipp Krüger <philipp.krueger1@gmail.com>
@palozano
Copy link
Contributor

palozano commented Sep 6, 2024 •
edited
Loading

@divagant-martian, this should be addressed by now, after merging all the PRs from #2702 up to #2711.
Thanks to @matheus23 for all the reviews!

@divagant-martian
Copy link
Contributor Author

Thanks a lot for your contributions!. I did not review the prs being on holidays but being now all merged I trust this is thoroughly addressed. Closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@palozano palozano

Labels
docs Improvements or additions to documentation
Projects
iroh
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@b5 @divagant-martian @palozano