UKHomeOffice / engineering-guidance-and-standards

Engineering Guidance and Standards for the Home Office
https://engineering.homeoffice.gov.uk
MIT License
18 stars 2 forks source link

[Enhancement] - Refactor docs directories to 'pubs' and 'docs' #467

Open edhamiltonHO opened 1 month ago

edhamiltonHO commented 1 month ago

What is the feature or enhancement you are suggesting? There are two directories in root of the repo that we suggest renaming docs change to pubs technical-docs change to docs

What would be the benefit of doing this? These repos were previously named so as to distinguish between the documents that were published on the site (principles, standards etc), and the technical documentation of the site implementation itself (e.g. decision log).

As we consider creating a golden repo of the eleventy and govuk-plugin implementation here, it is apparent that the current naming is not clear, and there are common naming conventions available which would be easier for developers and other users to understand.

Additional information N/A

Please confirm the below