About Docs

the developer portal — also called the wiki or the docs — is the main documentation for flipper one sub projects we update it as we work on flipper one, so some pages may change frequently this page explains how the docs are organized, how pages are stored and published, and how you can contribute about docs the docs sub project covers all documentation for flipper one this wiki, technical specs, datasheets, guides, and contribution instructions like all other flipper one sub projects, it is open for community contribution the docs sub project consists of ✅ task tracker https //github com/orgs/flipperdevices/projects/10 📁 source markdown files on github https //github com/flipperdevices/flipperone docs 📊 diagrams on miro https //miro com/app/board/uxjvj6y839o=/?movetowidget=3458764666602002588\&cot=10 🎨 illustrations on figma https //www figma com/design/hcwlmmijlw4loiqu4rtwwh/flipper one %e2%80%94 docs?node id=71 3\&t=56y5oaygklbg3nge 1 we'd love your feedback and help — look for tasks tagged help wanted in the task tracker, or contribute directly to the docs github repository via pull requests docs sub project structure how the developer portal works the flipper one developer portal is hosted on archbee https //archbee com , but all source files live in the github repository https //github com/flipperdevices/flipper one docs — made possible by archbee's github integration diagrams, screenshots, and illustrations are created in miro and figma, then exported to the repository alongside the markdown how the developer portal works the repository has one long lived branch public release — production branch connected to archbee all pull requests from contributors target public release once merged, archbee rebuilds and publishes the live docs at docs flipper net/one https //docs flipper net/one ✅ task tracker all docs sub project tasks are tracked in the github project flipper one — docs https //github com/orgs/flipperdevices/projects/10 there, you can see what the team is working on and find open tasks where the community can help docs board explainer tasks labeled help wanted are open for contribution you're welcome to join discussions or submit changes — just read the contribution guide docid 0qacsa2ejito2hwqfzgjh first 📁 github repository structure the flipperone docs https //github com/flipperdevices/flipperone docs repository contains the source files for the entire developer portal flipperone docs/ ├── archbee json # sidebar hierarchy + archbee integration settings ├── readme md # repository overview ├── tools/ │ └── generate open tasks py # generates open tasks md from github issues └── docs/ ├── welcome md # main page at docs flipper net/one ├── how to join md ├── open tasks md # auto generated — do not edit manually ├── files/ │ ├── pics/ # images and other assets │ └── icons/ # os / brand icons used in docs ├── general/ ├── hardware/ ├── mechanics/ ├── mcu firmware/ ├── cpu software/ ├── user interface/ ├── testing/ └── resources/ markdown and archbee syntax all pages in the developer portal are written in markdown ( md ) — the same format used for github readmes and most open source documentation on top of standard markdown, archbee adds a set of components for callouts, tabs, workflow blocks, embedded media, and more for the full list of supported syntax with live examples, see the markup example docid 43g4bbz9vhcuzq4hl9m1e page it covers headings, lists, links, and tables callouts images and videos code blocks and tabbed code workflow steps and other archbee components always check the markup example docid 43g4bbz9vhcuzq4hl9m1e page before writing or editing — some markdown features behave differently in archbee, and component syntax can be easy to mistype images and other assets all images, diagrams, and screenshots live in a single folder docs/files/pics/ keeping everything in one place makes it easier to find, reuse, and clean up unused files to use an image in a page, reference it from your markdown using a relative path !\[caption text]\(/files/pics/your image png) for richer archbee image syntax (positioning, captions, sizing), see the markup example docid 43g4bbz9vhcuzq4hl9m1e page ‎ naming and size guidelines use descriptive, lowercase filenames with hyphens — for example, gpio pinout png , not img 0042 png compress large screenshots before committing keep individual files under a few mb where possible prefer png for screenshots and diagrams, jpg for photos how archbee json works archbee json lives at the repo root and defines the developer portal's left sidebar (table of contents) sections, page names, file paths, and nesting levels when adding a new page, always update archbee json https //github com/flipperdevices/flipperone docs/blob/public release/archbee json to include it without this, the page will not appear in the sidebar, and readers won't be able to find it syntax the sidebar tree lives in structure docstree — an array of entries that are either pages or category groups for example { "root" " /docs", "structure" { "readme" "welcome md", "assets" "files", "docstree" \[ { "categoryname" "welcome", "iscategory" false, "path" "welcome md", "children" \[] }, { "categoryname" "🔌 hardware", "iscategory" true, "children" \[ { "categoryname" "about hardware", "iscategory" false, "path" "hardware/about hardware md", "children" \[] }, { "categoryname" "gpio port", "iscategory" false, "path" "hardware/gpio port md", "children" \[ { "categoryname" "gpio modules", "iscategory" false, "path" "hardware/gpio modules md", "children" \[] } ] } ] } ] } } ‎ rules pages are entries with a path to an md file inside docs/ categories are group headers that visually separate sections (for example, 🔌 hardware) they have no path — only nested entries any page can also have nested sub pages under it the sidebar label comes from categoryname emojis render as is and are purely cosmetic page metadata every page starts with a yaml frontmatter block at the top of the md file archbee reads two fields from it title — the page title shown as the h1 on the live site and as the page name in the sidebar do not add a # title line in the body — archbee will render it twice slug — the url path under docs flipper net/one/ example \ title about docs slug resources/about docs \ adding a new page create the md file under docs/ and set the title and slug fields in the frontmatter add an entry for it in archbee json → structure docstree at the right place in the hierarchy ideally, nesting should not go deeper than two levels open a pull request to the public release branch once merged, archbee rebuilds the live site 📊 diagrams on miro miro board example all diagrams used in the developer portal, architecture overviews, flow charts, and conceptual visuals are designed on the flipper one — docs miro board https //miro com/app/board/uxjvj6y839o=/ the board is publicly viewable anyone can open it, inspect existing diagrams and templates, and export a copy for reference or offline editing spotted an error or have an idea for a new diagram? share them with us in a pull request docid 0qacsa2ejito2hwqfzgjh 🎨 illustrations on figma figma file example illustrations used across the developer portal — section illustrations and decorative graphics are designed in the flipper one — docs figma file https //www figma com/design/hcwlmmijlw4loiqu4rtwwh/flipper one %e2%80%94 docs like the miro board, the figma file is publicly viewable you can browse every frame, inspect layers, and export illustrations at any resolution have an idea for a new illustration or a tweak to an existing one? share them with us in a pull request docid 0qacsa2ejito2hwqfzgjh how to contribute to contribute to the docs sub project, you need to have a github account you can create one on the github website https //github com/signup how to contribute to the docs before you start check open tasks in the task tracker https //github com/orgs/flipperdevices/projects/10 to see what the team is already working on or where help is wanted, and skim the markup example docid 43g4bbz9vhcuzq4hl9m1e page to get familiar with the supported markdown and archbee syntax fork the flipperone docs https //github com/flipperdevices/flipperone docs repository edit markdown files in the docs/ folder submit your work as a pull request to our github repo submit your fix or guide as a pull request if you've spotted an error, want to clarify a section, or want to add a new guide, you're welcome to contribute fork the repository, make your changes on a new branch, and submit a pull request to the original repository read the markup example docid 43g4bbz9vhcuzq4hl9m1e page to learn the supported markdown and archbee syntax fork the repository go to flipperone docs https //github com/flipperdevices/flipperone docs and click fork in the upper right corner your fork opens on the public release branch — the production branch connected to the live site all your work happens here edit or create your md file in your fork, find the file you want to edit under docs/ , or create a new one in the appropriate subfolder follow the syntax shown on the markup example page — some markdown features behave differently in archbee (optional) add images if your change includes images, diagrams, or screenshots, upload them to docs/files/pics/ and reference them with a relative path !\[alt text]\(/files/pics/your image png "caption") use descriptive, lowercase filenames with hyphens (e g gpio pinout png ) keep images under 1 mb (optional) register the new page in archbee json https //github com/flipperdevices/flipperone docs/blob/public release/archbee json place it in the sidebar hierarchy (no deeper than two levels) — see how archbee json works docid 0qacsa2ejito2hwqfzgjh for the syntax it's okay to skip — we'll update the file after merging your pr create a branch and commit name the branch nickname/what changed (e g john/github integration update ) keep commit messages concise — e g update rename authentication to auth open a pull request from your branch to the original repository the target is pre selected to public release — leave it as is add a clear title and description, and ideally attach screenshots and a link to the related open task make sure allow edits by maintainers is ticked so we can apply small wording or syntax fixes directly to your pr once merged, archbee publishes your changes to the live site once your pull request is merged into public release , archbee automatically picks up the changes and rebuilds the live site at docs flipper net/one https //docs flipper net/one suggest your change as a comment on an open task ⚠️ contributions only — no flooding to keep collaboration productive, please keep comments on topic open tasks are for contribution related discussion only if you have an idea or concern, first turn it into a concrete contribution and share it as a comment on a task for general questions or discussions, you’re always welcome to join the conversation on social media https //x com/flipper rnd or discord https //discord com/invite/flipper ! open tasks that need the community's help are labeled help wanted if you have ideas on how to improve a page, you can contribute by commenting on the task and attaching screenshots, videos, or links pick a task in the docs github project https //github com/orgs/flipperdevices/projects/10 , browse the open tasks and click the one labeled help wanted that you want to contribute to write your suggestion in the comments section, clearly describe your suggestion and, if helpful, attach a screenshot, video, or link to a draft pull request important if you share a link, ensure the content is accessible to others attachment size limit images 10 mb videos 100 mb click comment to submit we review all comments carefully! we may ask additional questions about your idea in the task thread, so please watch for github notifications in your email