Skip to content

Can I remove DESIGN.md after add .design folder and readme.md inside the folder? #48

Answered by fivenp
cosmic-flood asked this question in Q&A
Discussion options

You must be logged in to vote

Yes... Well said @cosmic-flood!
You can safely remove the DESIGN.md file once you created a .design folder with a README.md inside.

  • Having only a DESIGN.md is intended for rather small projects where all the guidelines can fit into one single file
  • Having the .design/ folder structure allows you to scale your documentation going forward

https://github.com/contribute-design/examples might give you an overview of how these guidelines can evolve over time (based on project type and how sophisticated the guides are :))

Replies: 1 comment

Comment options

You must be logged in to vote
0 replies
Answer selected by fivenp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
2 participants