{"id":41656241,"url":"https://github.com/tramlinehq/docs","last_synced_at":"2026-01-24T16:28:11.414Z","repository":{"id":83151679,"uuid":"441098270","full_name":"tramlinehq/docs","owner":"tramlinehq","description":"Documentation for Tramline","archived":false,"fork":false,"pushed_at":"2026-01-05T07:52:25.000Z","size":56317,"stargazers_count":5,"open_issues_count":13,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T15:47:20.751Z","etag":null,"topics":["documentation","docusaurus","release-engineering"],"latest_commit_sha":null,"homepage":"https://docs.tramline.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tramlinehq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-12-23T07:26:21.000Z","updated_at":"2026-01-05T07:52:29.000Z","dependencies_parsed_at":"2025-12-11T20:13:48.653Z","dependency_job_id":null,"html_url":"https://github.com/tramlinehq/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tramlinehq/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tramlinehq%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tramlinehq%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tramlinehq%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tramlinehq%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tramlinehq","download_url":"https://codeload.github.com/tramlinehq/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tramlinehq%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28731234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T10:24:43.181Z","status":"ssl_error","status_checked_at":"2026-01-24T10:24:36.112Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","docusaurus","release-engineering"],"created_at":"2026-01-24T16:28:11.335Z","updated_at":"2026-01-24T16:28:11.407Z","avatar_url":"https://github.com/tramlinehq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tramline Documentation\n[![GitHub](https://img.shields.io/github/license/tramlinehq/docs)](/LICENSE.md)\n[![Docusaurus](https://img.shields.io/badge/docusaurus-3.8.1-green)](https://docusaurus.io)\n\nThis documentation website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.\n\n### Installation\n\n```\n$ npm install\n```\n\n### Local Development\n\n```\n$ npm start\n```\n\nThis command starts a local development server (on port 3001) and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ npm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Search Index\n\nWe use Algolia to power search. This is done using a Docusaurus plugin. Changelogs are explicitly excluded from the index so as to not bloat the search experience with potentially conflicting information.\n\n### Writing Changelogs\n\nOur changelogs at [docs.tramline.app/changelog](https://docs.tramline.app/changelog) are powered by a [custom Docusaurus plugin](https://github.com/facebook/docusaurus/tree/main/website/src/plugins/changelog). While most edge cases are handled automatically, here are some important points to remember when writing changelogs:\n\n#### Version Numbers\n- Ignore version numbers in titles - the parser only reads dates in parentheses\n- We increment patch versions only to satisfy the parser\n\n#### Structure\n- Non-highlight improvements and fixes must use `\u003cdetails\u003e` tags\n- Always include a `\u003csummary\u003e` tag to avoid the default \"Details\" text\n- End each changelog with the `\u003cendcommiters/\u003e` tag\n- The `### Committers` section populates author icons but is removed from the final output\n\n#### Images\n- Image paths are relative to `$ROOT/changelog/*.md`\n- Example: When in `$ROOT/changelog/foo.md`, reference images from there\n\n#### Troubleshooting\n- If the output looks incorrect, simply delete `$ROOT/changelog`\n- The directory will automatically regenerate from `CHANGELOG.md`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftramlinehq%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftramlinehq%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftramlinehq%2Fdocs/lists"}