Skip to content
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

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

Open
1 task done
edhamiltonHO opened this issue Oct 11, 2024 · 0 comments
Open
1 task done

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

edhamiltonHO opened this issue Oct 11, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@edhamiltonHO
Copy link
Contributor

edhamiltonHO commented Oct 11, 2024

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

  • I have checked through the issues on the repository and this has not already been suggested
@edhamiltonHO edhamiltonHO added the enhancement New feature or request label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant