{"id":20779111,"url":"https://github.com/solidusio/edgeguides","last_synced_at":"2025-04-30T19:35:14.073Z","repository":{"id":43634603,"uuid":"266826614","full_name":"solidusio/edgeguides","owner":"solidusio","description":"Developer documentation for the Solidus eCommerce framework.","archived":false,"fork":false,"pushed_at":"2025-03-04T07:49:36.000Z","size":8116,"stargazers_count":9,"open_issues_count":10,"forks_count":29,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-23T23:09:48.467Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://guides.solidus.io","language":"MDX","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/solidusio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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},"funding":{"open_collective":"solidus"}},"created_at":"2020-05-25T16:22:41.000Z","updated_at":"2025-03-04T07:49:40.000Z","dependencies_parsed_at":"2023-10-03T17:04:56.901Z","dependency_job_id":"1b21c275-2cf7-4391-9a20-06606424cd03","html_url":"https://github.com/solidusio/edgeguides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio%2Fedgeguides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio%2Fedgeguides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio%2Fedgeguides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio%2Fedgeguides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidusio","download_url":"https://codeload.github.com/solidusio/edgeguides/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251769935,"owners_count":21640996,"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":["hacktoberfest"],"created_at":"2024-11-17T13:26:06.017Z","updated_at":"2025-04-30T19:35:14.044Z","avatar_url":"https://github.com/solidusio.png","language":"MDX","funding_links":["https://opencollective.com/solidus"],"categories":[],"sub_categories":[],"readme":"# Solidus Developer Documentation\n\nThis repository hosts the developer documentation for Solidus, the open-source eCommerce framework for industry\ntrailblazers.\n\nThe documentation, which is still a work in progress, is built using [Docusaurus 2](https://docusaurus.io/) and\npublished to https://edgeguides.solidus.io.\n\n## Installation\n\n```\n$ yarn\n```\n\n## Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without\nhaving to restart the server. This guide is versioned, so your live changes will be on http://localhost:3000/next.\n\n## Versions\n\nThe documentation in this repo is versioned for every major and minor release.\nAll changes merged to the main docs (under `docs/`) will refer to the `master` branch of the Solidus repo.\nPast versions won't generally be updated, but in case a patchlevel release requires a change it should be directed at the appropriate folder under `versioned_docs/`.\n\nWe have a helper script to backport documentation changes to previous versions. Run `bin/backport -h` for more information.\n\nIn order to release a new version from the documentation under `docs/` this command can be used:\n\n```\nnpm run docusaurus docs:version 1.2\n```\n\n## Docker development\n\n```\n$ docker-compose up -d\n```\n\nWait for the `app` container to be ready (you can check the logs with `docker-compose logs -f app`).\n\n```\n$ docker-compose exec app yarn start -h 0.0.0.0\n```\n\nNow you can access the documentation at http://localhost:3000.\n\n## Deployment\n\nThere's nothing special to do here: this website is published via Cloudflare Pages. All PRs generate a preview\nenvironment, and all commits to `main` will cause the main site to be rebuilt.\n\n## Contributing\n\nTo organize the documentation and make it more usable, the guides follow the [Diátaxis](https://diataxis.fr/)\nframework. If you are planning on making significant contributions, we strongly recommend getting familiar\nwith Diátaxis' taxonomy and conventions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio%2Fedgeguides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidusio%2Fedgeguides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio%2Fedgeguides/lists"}