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

[FEATURE] Separate README.md to a user and developer guide #46

Open
sam-herman opened this issue Mar 30, 2023 · 1 comment
Open

[FEATURE] Separate README.md to a user and developer guide #46

sam-herman opened this issue Mar 30, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@sam-herman
Copy link
Collaborator

Is your feature request related to a problem?

Currently there is a single README.md file that contains both info for developers and users.
It is recommended to have a separate more in-depth developer guide that will focus on debugging/development guidelines and separate from the mostly user oriented documentation currently in the README.

What solution would you like?

Add a DEVELOPER.md in addition to README.md content and move developer guidelines to DEVELOPER.md

What alternatives have you considered?

none
@sam-herman sam-herman added enhancement New feature or request untriaged labels Mar 30, 2023
@sam-herman sam-herman mentioned this issue Mar 30, 2023
Merged
@dblock dblock removed the untriaged label Jun 6, 2024
@dblock
Copy link
Member

dblock commented Jun 6, 2024

[Triage -- attendees 1, 2, 3, 4, 5, 6, 7]

Good suggestion, want to take a stab at this @samuel-oci?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dblock @sam-herman