{"id":27998272,"url":"https://github.com/alphagov/pay-tech-docs","last_synced_at":"2026-02-18T10:16:30.963Z","repository":{"id":14442456,"uuid":"76550775","full_name":"alphagov/pay-tech-docs","owner":"alphagov","description":"Technical documentation for GOV.UK Pay","archived":false,"fork":false,"pushed_at":"2025-05-08T19:23:14.000Z","size":9836,"stargazers_count":12,"open_issues_count":3,"forks_count":10,"subscribers_count":29,"default_branch":"main","last_synced_at":"2025-05-08T22:51:37.171Z","etag":null,"topics":["govuk-pay","portfolio","tech-docs-template"],"latest_commit_sha":null,"homepage":"https://docs.payments.service.gov.uk/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alphagov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-15T10:41:07.000Z","updated_at":"2025-04-24T08:36:38.000Z","dependencies_parsed_at":"2023-02-17T19:16:09.273Z","dependency_job_id":"b009dcce-837e-4935-bcf6-e822cff38ad3","html_url":"https://github.com/alphagov/pay-tech-docs","commit_stats":null,"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fpay-tech-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fpay-tech-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fpay-tech-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fpay-tech-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphagov","download_url":"https://codeload.github.com/alphagov/pay-tech-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253160826,"owners_count":21863624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["govuk-pay","portfolio","tech-docs-template"],"created_at":"2025-05-08T22:51:53.051Z","updated_at":"2026-02-18T10:16:25.936Z","avatar_url":"https://github.com/alphagov.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Technical Documentation\n\n## Getting started\n\nYou can [read documentation about the GDS technical documentation\ntool][tdt-documentation] [external link].\n\nTo preview or build the website, we need to use the terminal.\n\nInstall Ruby with Rubygems, preferably with a [Ruby version manager][rvm],\nand the [Bundler gem][bundler].\n\nIn the application folder type the following to install the required gems:\n\n```\nbundle install\n```\n\n### Optional analytics assets\n\nIn the application folder type the following to install optional client side\nJavascripts to enable the Google Analytics consent banner:\n\n```\nnpm install\n```\n\n## Making changes\n\nTo make changes edit the source files in the `source` folder.\n\nAlthough a single page of HTML is generated the markdown is spread across\nmultiple files to make it easier to manage. They can be found in\n`source/documentation`.\n\nA new markdown file isn't automatically included in the generated output. If we\nadd a new markdown file at the location `source/documentation/agile/scrum.md`,\nthe following snippet in `source/index.html.md.erb`, includes it in the\ngenerated output.\n\n```\n\u003c%= partial 'documentation/agile/scrum' %\u003e\n```\n\nIncluding files manually like this lets us specify the position they appear in\nthe page.\n\n## Preview\n\nWhilst writing documentation we can run a middleman server to preview how the\npublished version will look in the browser. After saving a change the preview in\nthe browser will automatically refresh.\n\nThe preview is only available on our own computer. Others won't be able to\naccess it if they are given the link.\n\nType the following to start the server:\n\n```\nbundle exec middleman server\n```\n\nIf all goes well something like the following output will be displayed:\n\n```\n== The Middleman is loading\n== LiveReload accepting connections from ws://192.168.0.8:35729\n== View your site at \"http://Laptop.local:4567\", \"http://192.168.0.8:4567\"\n== Inspect your site configuration at \"http://Laptop.local:4567/__middleman\", \"http://192.168.0.8:4567/__middleman\"\n```\n\nYou should now be able to view a live preview at http://localhost:4567.\n\n## Build\n\nIf you want to publish the website without using a build script you may need to\nbuild the static HTML files.\n\nType the following to build the HTML:\n\n```\nbundle exec middleman build\n```\n\nThis will create a `build` subfolder in the application folder which contains\nthe HTML and asset files ready to be published.\n\nDuring the build, [`html-proofer`](https://github.com/gjtorikian/html-proofer)\nwill check the HTML files for broken internal links.\n\n## Updating the template\n\nYou can update to the latest version of [tech-docs-template][] by running:\n\n```\nbundle update govuk_tech_docs\n```\n\nRead [the changelog for the gem][gem-changelog] for the latest changes.\n\n[gem-changelog]: https://github.com/alphagov/tech-docs-gem/blob/main/CHANGELOG.md\n\n[rvm]: https://www.ruby-lang.org/en/documentation/installation/#managers\n[bundler]: http://bundler.io/\n[tdt-documentation]: https://tdt-documentation.london.cloudapps.digital\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fpay-tech-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphagov%2Fpay-tech-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fpay-tech-docs/lists"}