slalombuild / secureli

seCureLI is a tool that enables you to experience the delight of building products by helping you get ideas from your head into working software as frictionlessly as possible, in a reliable, secure, scalable, and observable way.
Apache License 2.0
29 stars 3 forks source link

docs: secureli 540 update documentation #560

Closed itoltz closed 4 weeks ago

itoltz commented 1 month ago

secureli-540

This ticket was about a problem with configuring the pre-commit library. I determined that the issue was due to misconfiguration by the user, and the solution we settled on was to add documentation about how to specify args in the pre-commit library's configuration file.

Additionally, I updated headings throughout the file. Previously there were multiple H1s, and the License section was nested underneath the Configuration section. I've updated it so that there is only a single H1 heading--the title of the document--and the License section is now a sibling of configuration instead of a child.

Changes

Testing

Clean Code Checklist