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

Add access to comprehensive documentation directly from the CLI. #13

Closed
Tracked by #6
simonsan opened this issue Feb 14, 2024 · 0 comments · Fixed by #53
Closed
Tracked by #6

Add access to comprehensive documentation directly from the CLI. #13

simonsan opened this issue Feb 14, 2024 · 0 comments · Fixed by #53
Labels
A-cli Area: Related to our command line interface A-docs Area: Improvements or additions to documentation A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request

Comments

@simonsan
Copy link
Contributor

simonsan commented Feb 14, 2024

Something like a docs command could be helpful:

//! `docs` subcommand

use abscissa_core::{status_err, Application, Command, Runnable, Shutdown};
use clap::Args;

use crate::application::PACE_APP;

/// Opens the documentation.
#[derive(Command, Debug, Args, Clone)]
pub struct DocsCmd {
  dev: bool
}

impl Runnable for DocsCmd {
    fn run(&self) {
        match open::that("https://pace.cli.rs/docs") {
            Ok(_) => {}
            Err(err) => {
                status_err!("{}", err);
                PACE_APP.shutdown(Shutdown::Crash);
            }
        };
    }
}
@simonsan simonsan added A-cli Area: Related to our command line interface A-docs Area: Improvements or additions to documentation A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request labels Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-cli Area: Related to our command line interface A-docs Area: Improvements or additions to documentation A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant