{"id":21835737,"url":"https://github.com/vtex/action-internal-docs","last_synced_at":"2026-01-23T14:45:43.794Z","repository":{"id":36968761,"uuid":"344472908","full_name":"vtex/action-internal-docs","owner":"vtex","description":"GitHub Action to automatically publish your documentation to VTEX Tech Docs","archived":false,"fork":false,"pushed_at":"2023-10-13T17:53:08.000Z","size":1265,"stargazers_count":1,"open_issues_count":12,"forks_count":2,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-10-23T09:52:47.011Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/vtex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-04T12:50:56.000Z","updated_at":"2023-10-13T17:51:51.000Z","dependencies_parsed_at":"2023-10-14T17:27:18.826Z","dependency_job_id":null,"html_url":"https://github.com/vtex/action-internal-docs","commit_stats":{"total_commits":108,"total_committers":5,"mean_commits":21.6,"dds":"0.35185185185185186","last_synced_commit":"1933bb99c887fb5389dc49e72b37016bd5a9abdf"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/vtex/action-internal-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-internal-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-internal-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-internal-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-internal-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/action-internal-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-internal-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28694457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T14:15:13.573Z","status":"ssl_error","status_checked_at":"2026-01-23T14:09:05.534Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2024-11-27T20:24:10.362Z","updated_at":"2026-01-23T14:45:43.760Z","avatar_url":"https://github.com/vtex.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VTEX Internal Docs Action\n\nVTEX Internal Docs is an internal documentation solution that enables teams to \ncollaborate seamlessly by having internal documentation distributed across \nmultiple repos and rendered in a beautiful documentation portal available for \nall VTEX employees that have a github user in the `vtex` organization.\n\nThis GitHub Action syncs the documentation on your repository with the main \n[Internal Docs repo], which is used to build the Internal Docs website.\n\nIf you have any questions, reach out to us at [#tech-docs].\n\n## Benefits\n\n- A single place for all VTEX internal documentation: no more looking for docs \n  at notion or github wikis, go to a single place and find all your internal \n  docs needs.\n- Find what you need easily: VTEX Internal Docs search works!\n- Keep your docs close to your code: no need to open separate Pull requests in \n  other repos to document your systems.\n\n## Architecture\n\nVTEX Internal Docs is supposed to be used with a github workflow in order to \nsend data from a github repo to `vtex/internal-docs` repo.\n\nThis workflow needs a token with write access to the `vtex/internal-docs` repo.\n\nAt any push to branches `main` or `master`, the workflow will grab all \ndocumentation inside `docs/` folder of your repo and will send it to the \nsubfolder that you define on `docs-product` variable of the workflow.\n\n![Architecture overview of Internal Docs publishing flow](./architecture.png)\n\n## How to Use\n\n1. Create a folder called `.github/workflows` in the root of your repo, if it \n   doesn't already exists.\n\n2. Create a workflow inside your repo, for example `internal-docs.yml`\n\n3. Fill the workflow with the following yml file. Don't forget to change the \n   `docs-product` variable.\n\n```yml\nname: \"Internal Docs Integration\"\non:\n  push:\n    branches:\n    - master\n    - main\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n    - uses: actions/checkout@v2\n    - uses: vtex/action-internal-docs@main\n      with:\n        repo-token: ${{ secrets.INTERNAL_DOCS_GH_TOKEN }}\n        docs-product: {YOUR_TEAM_NAME_HERE, e.g. Identity, Cloud-Services}\n```\n\n4. From now on, every push on branches `master` or `main` will sync your files \n   in the `docs/` folder to the `vtex/internal-docs` repo and it will be made \n   available on `https://internal-docs.vtex.com/`\n\n## Contributing\n\nIf you want to contribute to this repo, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n[#tech-docs]: https://vtex.slack.com/archives/C01U3LVT11B\n[Internal Docs repo]: http://github.com/vtex/internal-docs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Faction-internal-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Faction-internal-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Faction-internal-docs/lists"}