{"id":26064643,"url":"https://github.com/mage-os/devdocs","last_synced_at":"2025-03-08T18:42:12.574Z","repository":{"id":176706966,"uuid":"657054919","full_name":"mage-os/devdocs","owner":"mage-os","description":"Mage-OS devdocs","archived":false,"fork":false,"pushed_at":"2025-02-19T18:14:22.000Z","size":496,"stargazers_count":13,"open_issues_count":18,"forks_count":24,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-01T14:24:26.687Z","etag":null,"topics":["adobecommerce","documentation","ecommerce","mage-os","magento2"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mage-os.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"security-features-in-magento-2.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-06-22T08:08:34.000Z","updated_at":"2025-02-19T18:14:26.000Z","dependencies_parsed_at":"2023-10-20T22:29:36.708Z","dependency_job_id":null,"html_url":"https://github.com/mage-os/devdocs","commit_stats":null,"previous_names":["mage-os/devdocs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mage-os%2Fdevdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mage-os","download_url":"https://codeload.github.com/mage-os/devdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242099012,"owners_count":20071509,"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":["adobecommerce","documentation","ecommerce","mage-os","magento2"],"created_at":"2025-03-08T18:42:12.033Z","updated_at":"2025-03-08T18:42:12.567Z","avatar_url":"https://github.com/mage-os.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hello, Mage-OS Developer! 👋\n\nWelcome to the Mage-OS DevDocs repository. If you're here to contribute, or even just to learn, we're thrilled to have\nyou. Below are some guidelines and notes to make your experience with us smooth and beneficial for everyone.\n\n## 🎉 Every Contribution Counts!\n\nWe genuinely mean it when we say every contribution counts. Did you spot a typo? Feel the need to correct a spelling\nissue? Even these small gestures go a long way in enhancing the quality of our DevDocs. So, don't hesitate. We\nappreciate your keen eyes!\n\n## 📋 Issues \u0026 Topics\n\nIf there's something you'd like to see documented or feel something's amiss, don't just keep it to yourself. Open up an\nissue! We're always on the lookout for topics that can add value to Mage-OS DevDocs.\n\n## 🗺 Navigation \u0026 New Pages\n\nWant to add a new page? Great! Make sure you reference it in the documentation.md which serves as our central\nnavigation. This ensures everyone can find your valuable addition.\n\n## 📄 Formatting \u0026 Structure\n\nEvery document you create should start with a `# Headline` and be followed by a `[TOC]`. This helps in generating the\nTable of Contents. We plan to add help in the form of GitHub Actions to point out potential Layout Flaws, misspellings,\ntoxic language, non-inclusive language, or similar issues.\n\n## 🗣 Tone \u0026 Voice\n\nDocumentation can often feel like a tedious read, but not here. While we aim to be exact and knowledgeable, we also\nstrive to be beginner-friendly. Put on your informative cap, but remember, our readers range from beginners to experts.\nAim for clarity and simplicity.\n\n## 🎙 Join Our Discord Community\n\nGot questions? Need clarifications? Or just want to chat? Join us on our Discord Server! Hop into the #documentation\nchannel for all things related to the DevDocs. We're a friendly bunch, and someone's always around to help or have a\nchat. Join the Discord Server\n\n## 🖼 Images\n\nA picture's worth a thousand words! If you'd like to add images to your documentation, please place them in the media\ndirectory. This helps keep things neat and organized.\n\n## 🚀 Keep It Simple\n\nWe've designed this repository to be as straightforward as possible. You'll mostly find Markdown files and the media\ndirectory here. No fancy structures. No complicated workflows. We like to keep things light and breezy.\n\n## ⚠️ Disclaimer\n\nA portion of our initial documentation was crafted with the assistance of artificial intelligence. While it has provided\nvaluable insights, not everything has undergone a human review or validation. We're continuously working on enhancing\nand verifying the content, but if you spot any inaccuracies, do bring it to our attention.\n\n# Mage-OS Documentation\n\n## 💅🏻 Markup and Features\n\nWe support GitHub Flavored Markdown, including code blocks with triple backticks. You can also add highlight areas\nwithin your documentation.\n\n![Preview of Markdown rendered Info Boxes](media%2Fpreview_of_info_boxes.png)\n\n```markdown\n\u003e **Note**  \n\u003e Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime\nperspiciatis quae sapiente sunt veniam, voluptatum?\n\n\u003e **Warning**  \n\u003e Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime\nperspiciatis quae sapiente sunt veniam, voluptat?\n```\n\nFor more details, see\nthe [GitHub Flavored Markdown documentation](https://help.github.com/articles/github-flavored-markdown/).\n\n## Contribution Guidelines\n\nThis repository is part of a 2-repositores project structure:\n- https://github.com/mage-os/devdocs-website has all the software\n- https://github.com/mage-os/devdocs as all the documentation\n\nIf you want to build devdocs locally or understand more on the build process, please refer to https://github.com/mage-os/devdocs-website too.\n\nIf you are submitting documentation for the **current stable release**, submit it to the corresponding branch. For\nexample, documentation for Mage-OS 2.5.6 would be submitted to the `2.5.6` branch. Documentation intended for the next\nrelease of Mage-OS should be submitted to the `main` branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fdevdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmage-os%2Fdevdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmage-os%2Fdevdocs/lists"}