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

[FEATURE] Separate "reference" docs from feature/tutorial docs #219

Open
1 task done
adambkaplan opened this issue Feb 7, 2024 · 1 comment
Open
1 task done
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.
Milestone

Comments

@adambkaplan
Copy link
Member

Is there an existing feature request for this?

  • I have searched the existing feature requests

Is your feature request related to a problem or use-case? Please describe.

The CLI docs co-mingle reference docs (generated) with feature-related content (ex: local source upload).

Describe the solution that you would like.

Auto-generated content should be moved to a sub-directory under docs, such as reference

Describe alternatives you have considered.

Keep current state.

Anything else?

Related to shipwright-io/website#110 - a separate sub-directory will make it simpler for the website to present reference materials separately from tutorial/concept driven content.

@adambkaplan adambkaplan added the kind/feature Categorizes issue or PR as related to a new feature. label Feb 7, 2024
@adambkaplan adambkaplan added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 7, 2024
@qu1queee qu1queee added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Feb 8, 2024
@adambkaplan adambkaplan added this to the Backlog milestone Dec 12, 2024
@adambkaplan
Copy link
Member Author

From refinement - adding as an accepted backlog item.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.
Projects
Status: Todo
Development

No branches or pull requests

2 participants