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

Make sure the docs folder is up to date with new structure #3639

Closed
3 tasks done
Tracked by #3291
stevenjmesser opened this issue May 15, 2023 · 1 comment · Fixed by #3975
Closed
3 tasks done
Tracked by #3291

Make sure the docs folder is up to date with new structure #3639

stevenjmesser opened this issue May 15, 2023 · 1 comment · Fixed by #3975
Assignees

Comments

@stevenjmesser
Copy link

stevenjmesser commented May 15, 2023

What

Check that the documentation inside the repository (in docs) are up to date with the new repository structure, especially:

  • the docs for releasing to npm
  • the docs for pushing a pre-release as a branch on Github
  • but also all the other pieces of documentation in there

Why

We're making substantial changes to our repository structure ahead of v5. We need to ensure that our docs reflect these changes so they can help future us and contributors appropriately.

Pushing a pre-release branch, especially, is really helpful for contributors as it allows them to install their changes as an npm package (without releasing to npm)

Who needs to work on this

Developers, Tech writers?

Who needs to review this

Developers, Tech writers?

Done when

We've reviewed

Preview Give feedback
@romaricpascal romaricpascal changed the title Make sure documentation is up to date with new structure Make sure GitHub documentation is up to date with new structure May 15, 2023
@romaricpascal romaricpascal changed the title Make sure GitHub documentation is up to date with new structure Make sure docs is up to date with new structure May 15, 2023
@romaricpascal romaricpascal changed the title Make sure docs is up to date with new structure Make sure the docs folder is up to date with new structure May 15, 2023
@36degrees 36degrees moved this from Backlog 🗄 to Sprint Backlog 🏃🏼‍♀️ in GOV.UK Design System cycle board Jul 11, 2023
@romaricpascal romaricpascal linked a pull request Jul 18, 2023 that will close this issue
@romaricpascal
Copy link
Member

romaricpascal commented Jul 18, 2023

Closed by #3975 (the PR was referencing the wrong issue). The docs have been reviewed, but we'll open issues should any problem arise when running our first pre-releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

2 participants