Skip to content

Commit 91799c3

Browse files
committed
Update README to reflect what this is
This repo contains the docs for the Prototype Kit, not the Prototype Kit itself. The README is pretty much unchanged from when this was forked from the kit, so update the README to try and reflect what this repo actually contains. This also means we can remove out of date support info from the README. I have added a note about the history of this repo which I found confusing.
1 parent f6f1f2b commit 91799c3

File tree

1 file changed

+9
-33
lines changed

1 file changed

+9
-33
lines changed

README.md

+9-33
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,20 @@
1-
# GOV.UK Prototype Kit
1+
# GOV.UK Prototype Kit Docs
22

3-
Go to the [GOV.UK Prototype Kit site](https://prototype-kit.service.gov.uk/docs/) to download the latest version and read the documentation.
3+
This repository contains the code for the [GOV.UK Prototype Kit website](https://prototype-kit.service.gov.uk/docs/).
44

5-
## About the Prototype Kit
5+
The code for the Prototype Kit can be found at [alphagov/govuk-prototype-kit](https://github.com/alphagov/govuk-prototype-kit).
66

7-
The Prototype Kit provides a simple way to make interactive prototypes that look like pages on GOV.UK. These prototypes can be used to show ideas to people you work with, and to do user research.
7+
## History of this repo
88

9-
Read the [project principles](https://prototype-kit.service.gov.uk/docs/principles).
9+
The Prototype Kit used to include its own documentation, and the Prototype Kit website was a deployed version of the Prototype Kit with specific flags set to always redirect to the documentation.
1010

11-
## Make sure prototypes are password-protected
11+
This repo was originally created in 2020 to spike a new documentation site based on the Design System website.
1212

13-
If you publish your prototypes online, they **must** be protected by a [username and password](https://prototype-kit.service.gov.uk/docs/publishing-on-heroku). This is to prevent members of the public finding prototypes and thinking they are real services.
13+
In June 2022 the documentation was removed from the Prototype Kit repo. At that point, the history of the `main` branch for this repo was rewritten to have the same history as the Prototype Kit repo, preserving the documentation so that it could be served from this repo instead.
1414

15-
You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like GOV.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.
15+
The original history from the spike is preserved in the `from-govuk-design-system` branch.
1616

17-
## Installation instructions
18-
19-
- [Installation guide for new users (non technical)](https://prototype-kit.service.gov.uk/docs/install/introduction)
20-
- [Installation guide for developers (technical)](https://prototype-kit.service.gov.uk/docs/install/developer-install-instructions)
21-
22-
## Support
23-
24-
The GOV.UK Prototype Kit is maintained by the Government Digital Service. If you’ve got a question or need support you can:
25-
26-
27-
* [get in touch on Slack](https://ukgovernmentdigital.slack.com/archives/C0647LW4R)
28-
* [view known issues on GitHub](https://github.com/alphagov/govuk-prototype-kit/issues)
29-
30-
## Contributing
31-
32-
If you’ve got an idea or suggestion, you can:
33-
34-
* [get in touch on the developer Slack channel](https://ukgovernmentdigital.slack.com/archives/C0E1063DW)
35-
* [create a GitHub issue](https://github.com/alphagov/govuk-prototype-kit/issues)
36-
37-
The govuk-prototype-kit repository is public and we welcome contributions from anyone.
38-
39-
Contributors to alphagov repositories are expected to follow the [Contributor Covenant Code of Conduct](https://github.com/alphagov/.github/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct). Contributors working within government are also expected to follow the [Civil Service code](https://www.gov.uk/government/publications/civil-service-code/the-civil-service-code).
40-
41-
We're unable to monitor activity on this repository outside of our office hours (10am to 4pm, UK time). To get a faster response at other times, you can [report abuse or spam to GitHub](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).
17+
[Read issue #22 for more information](https://github.com/alphagov/govuk-prototype-kit-docs/issues/22#issuecomment-1162876785).
4218

4319
### Security
4420

0 commit comments

Comments
 (0)