{"id":38660611,"url":"https://github.com/openbraininstitute/platform-docs","last_synced_at":"2026-01-17T09:38:19.643Z","repository":{"id":272320817,"uuid":"916020875","full_name":"openbraininstitute/platform-docs","owner":"openbraininstitute","description":"OBP Architecture Documentation","archived":false,"fork":false,"pushed_at":"2026-01-12T15:19:38.000Z","size":4559,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-12T21:34:24.934Z","etag":null,"topics":["architecture","documentation"],"latest_commit_sha":null,"homepage":"https://openbraininstitute.github.io/platform-docs/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openbraininstitute.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2025-01-13T09:58:42.000Z","updated_at":"2026-01-12T15:19:42.000Z","dependencies_parsed_at":"2025-12-16T17:08:38.450Z","dependency_job_id":null,"html_url":"https://github.com/openbraininstitute/platform-docs","commit_stats":null,"previous_names":["openbraininstitute/platform-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openbraininstitute/platform-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbraininstitute%2Fplatform-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbraininstitute%2Fplatform-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbraininstitute%2Fplatform-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbraininstitute%2Fplatform-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openbraininstitute","download_url":"https://codeload.github.com/openbraininstitute/platform-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbraininstitute%2Fplatform-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28505565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"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":["architecture","documentation"],"created_at":"2026-01-17T09:38:09.985Z","updated_at":"2026-01-17T09:38:18.017Z","avatar_url":"https://github.com/openbraininstitute.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **Open Brain Platform** - Documents\n\nThis is a work-in-progress repository containing:\n\n* the [Architecture Documentation](docs/) of the **Open Brain Platform**\n* the review documents for the [AWS Well-Architected Framework](waf)\n\n## File format conventions\n\nFor convenience:\n\n* the file format utilized for the documentation is [Markdown](https://en.wikipedia.org/wiki/Markdown)\n* the file format utilized for the diagrams is either:\n    * Scalable Vector Graphics (SVG) made with [Draw.io](https://github.com/jgraph/drawio), for complex diagrams requiring precise control over the layout, styling, and visual elements.\n      Examples: Detailed flowcharts, network architectures, or visualizations requiring specific branding or icons.\n    * Inline diagrams made with [Mermaid](https://github.com/mermaid-js/mermaid), for simple diagrams that can be defined easily in text.\n      Examples: Simple flowcharts, sequence diagrams.\n\n## How to Edit the Documentation and Diagrams\n\nOne of the main reasons behind choosing the formats mentioned above, is the convenience of having automatically available VSCode on GitHub for the very same repository. No installations nor complex configurations are required.\n\n**To edit any of the files, including the diagrams, you must simply access the following link to open VSCode:**\n\n[![Edit repository with Visual Studio Code](.vscode/resources/edit_in_vscode.drawio.svg)](https://github.dev/openbraininstitute/platform-docs)\n\nThe repository contains a `.vscode` folder with a recommendation to enable the following plugins for VSCode:\n\n* [Draw.io Integration](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) (see also [Edit diagrams directly in GitHub with draw.io and github.dev](https://www.drawio.com/blog/edit-diagrams-with-github-dev))\n* [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)\n\nSimply click on `Install` when prompted in the bottom-right of your screen, and from now on you will be able to edit any of the Draw.io figures and Mermaid diagrams inside GitHub.\n\n\u003e [!TIP]\n\u003e You can also clone the repository locally and utilize your own installation of VSCode. The same plugins are available in both versions.\n\n\u003e [!WARNING]\n\u003e Please, use **always** Mermaid or SVG file format while working with new figures. Name the SVG files as `*.drawio.svg` for the plugin to automatically detect the Draw.io files in VSCode.\n\nIf using IntelliJ or other JetBrains IDEs based on it, like PyCharm, there are equivalent plugins:\n\n* [Diagrams.​net Integration](https://plugins.jetbrains.com/plugin/15635-diagrams-net-integration)\n* [Mermaid](https://plugins.jetbrains.com/plugin/20146-mermaid)\n\n\n## Acknowledgements\n\nThe development of this was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.\n\nFor license see LICENSE.txt.\n\nCopyright (c) 2023-2024 Blue Brain Project/EPFL\n\nCopyright (c) 2025 Open Brain Institute\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbraininstitute%2Fplatform-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbraininstitute%2Fplatform-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbraininstitute%2Fplatform-docs/lists"}