-
Notifications
You must be signed in to change notification settings - Fork 107
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 REQUEST] Remove unnecessary design docs. #2864
Comments
@seriva , @atsikham , @to-bar, @plirglo, (and all others) Please tell me, what do you think about the new approach for design-doc:
In the following approach, we would avoid a mess in this documentation. If you agree, I will remove all .md's not related to the release 2.0 version (everything beside rook). |
Yeah I think this is a good idea. |
IMO if feature is present in source code then corresponding design-doc may be helpful for someone to get familiar with the feature (especially when the doc contains a diagram) or to find out why a decision was made. For me standard docs are rather addressed to users (how to use, user guide) and design-docs are addressed to team members or advanced users (how it works or why that's way). But I see one problem with keeping a design-doc as long as feature is present - it should be updated - keep in sync with implementation and later changes. |
Is your feature request related to a problem? Please describe.
We have old design docs that can be misleading for someone using Epiphany.
Describe the solution you'd like
We want to review existing design docs and remove unnecessary ones.
Describe alternatives you've considered
None.
Additional context
None.
DoD checklist
The text was updated successfully, but these errors were encountered: