{"id":42598992,"url":"https://github.com/nspcc-dev/neofs-spec","last_synced_at":"2026-01-29T00:16:20.732Z","repository":{"id":38314373,"uuid":"276705736","full_name":"nspcc-dev/neofs-spec","owner":"nspcc-dev","description":"NeoFS Technical Specification","archived":false,"fork":false,"pushed_at":"2025-11-28T13:00:29.000Z","size":2761,"stargazers_count":6,"open_issues_count":19,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-11-29T11:49:18.197Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nspcc-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2020-07-02T17:19:14.000Z","updated_at":"2025-11-26T14:21:10.000Z","dependencies_parsed_at":"2023-01-19T15:31:51.807Z","dependency_job_id":"935da130-222e-4755-843f-e31839f6a7a6","html_url":"https://github.com/nspcc-dev/neofs-spec","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nspcc-dev/neofs-spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nspcc-dev%2Fneofs-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nspcc-dev%2Fneofs-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nspcc-dev%2Fneofs-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nspcc-dev%2Fneofs-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nspcc-dev","download_url":"https://codeload.github.com/nspcc-dev/neofs-spec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nspcc-dev%2Fneofs-spec/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28857415,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T22:56:21.783Z","status":"ssl_error","status_checked_at":"2026-01-28T22:56:00.861Z","response_time":57,"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":"2026-01-29T00:16:19.223Z","updated_at":"2026-01-29T00:16:20.712Z","avatar_url":"https://github.com/nspcc-dev.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"./.github/logo.svg\" width=\"500px\" alt=\"NeoFS\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://fs.neo.org\"\u003eNeoFS\u003c/a\u003e Technical Specification\n\u003c/p\u003e\n\n---\n\n## Document format\nThis document uses a mix of Markdown and LaTeX in [pandoc](https://pandoc.org/) flavors. Target output formats are PDF and HTML.\n\nFor non-generated plain text we follow single line paragraph style.\n\n## Build instructions (manual build)\nInstall pandoc and LaTeX base. Please see Dockerfile for the detailed list of what you might need.\n\nAfter pandoc and LaTeX base are available, you can simply run `make`, which will generate the specification paper in pdf and html.\n\n## Build using docker\nThe easiest way to build a specification document is to use [Docker](https://www.docker.com). Just add `docker/` to any Makefile target to run it inside a container having all required tools already available.\n\n* Compile the specification paper pdf using `make docker/pdf`\n* Output will be generated as `output/neofs-spec-\u003crevision\u003e.pdf`\n\nYou can build docker image locally with `make image` command.\n\n## How to contribute\nIf you know NeoFS technology and want to contribute, feel free to directly submit a Pull Request with the desired changes.\n\nInitially, the idea is to create a broad and complete initial version of the document, which will be polished in the future.\n\n## Adding pictures\nPictures should be placed in `pic` directory of the corresponding section. Vector formats are preferred and strongly recommended. Please always provide the source file for the picture to allow future edits.\n\nExpected formats:\n* [PlantUML](plantuml.com)\n* [Draw.io](https://github.com/jgraph/drawio-desktop)\n* SVG\n* PDF\n* PNG\n* JPG\n\nWhen referencing a picture in the document text, please omit file extension. Most appropriate format will be used depending on the document output format.\n\nExample:\n```\n![Architecture overview](pic/overview-sc2)\n```\n\nTo render all PlantUML files to SVG run `make puml2svg` or `make docker/puml2svg`\n\nTo convert all SVG files to PDF `make svg2pdf` or `make docker/svg2pdf`\n\n### PlantUML\nPlace [PlantUML](plantuml.com) files under `pic/` directory of the corresponding section and name it with `.puml` or `.plantuml` file extension. It will be automatically rendered to SVG format by `puml2svg` make target.\n\n### Draw.io\n[Draw.io](https://github.com/jgraph/drawio-desktop) diagrams must be exported to SVG format and saved under `pic/` directory of corresponding section. To avoid text rendering errors, please follow [this guide](https://desk.draw.io/support/solutions/articles/16000042487). Don't enable `Embed Images` checkbox, or raster image version will be saved in PDF instead of vector image version.\n\nPlease palace the source `.drawio` file in the same directory with exported SVG to allow future edits.\n\n## License\n\nLicense: CC BY-NC-SA 4.0\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003e\u003cimg alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003eCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International License\u003c/a\u003e.\n\nPandoc/LaTeX template [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template/) is licensed by BSD 3-Clause License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnspcc-dev%2Fneofs-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnspcc-dev%2Fneofs-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnspcc-dev%2Fneofs-spec/lists"}