search

confidential-containers / documentation

Documentation for the confidential containers project
Apache License 2.0
73 stars 48 forks source link

standardize format of documentation filenames #50

Closed fitzthum closed 2 years ago

fitzthum commented 2 years ago

We have a bunch of different approaches to naming our documentation files. Let's pick one so it looks legit.

Some options:

What should we do?

bpradipt commented 2 years ago

README.md - default when creating Github project

fitzthum commented 2 years ago

README.md - default when creating Github project

Yeah this basically standard, but I there could be some debate about which other files should be uppercase.

fitzthum commented 2 years ago

Ok, having looked around a bit (mainly at various Rust crates), I think we should go with snake_case for the documentation files. README.md and other files aren't documentation files so they will stay uppercase.

fitzthum commented 2 years ago

Fixed by #51