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 name/description to devbox init #2093

Open
vhsantos opened this issue May 28, 2024 · 0 comments
Open

Add name/description to devbox init #2093

vhsantos opened this issue May 28, 2024 · 0 comments
Labels
feature New feature or request triage Issue needs triage

Comments

@vhsantos
Copy link
Contributor

vhsantos commented May 28, 2024

What problem are you trying to solve?

When generating the documentation devbox generate readme some sections (name/description) on the Markdown are missing, because this fields don't exists on the devbox.json file, example:

Current:

<!-- gen-readme start - generated by https://github.com/jetify-com/devbox/ -->
## Getting Started

This project uses [devbox](https://github.com/jetify-com/devbox) to manage its development environment.

Install devbox:
====

Expected:

====
<!-- gen-readme start - generated by https://github.com/jetify-com/devbox/ -->

# My Project Name

It is always nice to have some description.

## Getting Started

This project uses [devbox](https://github.com/jetify-com/devbox) to manage its development environment.

Install devbox:
====

What solution would you like?

When running the command
devbox init

Give the user some options/flags to allow passing or filling in the name/description.

$devbox init --name "My Project Name" --description "It is always nice to have some description."

or

$devbox init --interactive
Project Name: My Project Name
Project Description: It is always nice to have some description.
Devbox project created
$

Alternatives you've considered

No response

@vhsantos vhsantos added feature New feature or request triage Issue needs triage labels May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request triage Issue needs triage
Development

No branches or pull requests

1 participant