Editor

download native app how to download the native app of archbee? press on help help icon form bottom right corner to open the help menu, then click on the "download the native app" the system will detect your device os and will start downloading the app spaces how to delete a space? to delete a space, open the space settings modal (by clicking on the gear icon), and in the "general" modal, click on the "delete space" button a new modal will appear that warn you this will permanently delete the current space once you delete a space, there is no going back, even if you contact support\@archbee com mailto\ support\@archbee com please be certain to confirm, you have to write the name of the space in the input field and then, press on "delete space" button the intput field is case sensitive you have to write the exact name of your space (including upper case, lower case and symbols) the final "delete space" button is disabled until you write the exact space name all this is to ensure that there is no human error and this action is 100% intended version links swimlane explanation archbee space versions best practices & workflow this guide outlines the recommended workflow for managing sequential software releases (e g , v25 4 x, v25 5 0) using archbee space versions it is designed to ensure stability across your production documentation while allowing for parallel development of future releases 1 core concept the "main space" in a versioned documentation architecture, one specific space serves as the parent or main space this is typically your currently active production documentation (e g , piedpiper 25 4 x ) and serves as the primary "source of truth" for your project structure main space (the hub) this is the control center for your documentation set it is the designated location where you must manage settings, configure access, and generates new version branches think of it as the "trunk" of the tree from which all other branches grow versions (the branches) these are independent snapshots branched directly from the main space once created, they function as distinct entities they are typically used to archive past releases (e g , v24 0) or to draft future documentation (e g , v26 0) in isolation without risking changes to the live production site 2 the golden rule of versioning ⚠️ critical always create and manage versions specifically from the main space to maintain a healthy version tree, you must strictly adhere to the parent child relationship when you need to create a new version (e g , strictly creating the 25 6 0 draft while 25 4 x is live), you must return to the source open the main space ( piedpiper 25 4 x ) navigate to space settings > version links create the new version entry here ⛔ what not to do never open a child version (e g , the piedpiper 25 5 0 draft) to create a subsequent version why? space versions are designed to be siblings of each other, all children of the main space the risk attempting to branch a "grandchild" version (creating a version from another version) disrupts the hierarchy this often leads to broken navigation menus, orphaned spaces that do not appear in the dropdown, and fragmented search indexes the exception (patch versions) you may branch from a child version only if you are creating a direct patch update (e g , branching from 25 5 0 to create 25 5 1 ) never use a child version to create the next major or minor release (e g , do not use 25 5 0 to create 25 6 0 ) 3 recommended workflow for "piedpiper" the scenario live production piedpiper 25 4 x (visible to customers) in development piedpiper 25 5 0 and 25 6 0 (internal drafts) step by step guide set the foundation verify that piedpiper 25 4 x is your designated main space this ensures all future versions share a common origin point create draft versions from within piedpiper 25 4 x , go to the version links settings create the version piedpiper 25 5 0 create the version piedpiper 25 6 0 note this copies the current state of 25 4 x into these new spaces as a starting point control visibility piedpiper 25 4 x keep this published (public) this ensures your customers always land on the stable documentation piedpiper 25 5 0 & 25 6 0 keep these private by not publishing them this allows your internal technical writers and reviewers to access, edit, and audit the content, but effectively hides them from the public version dropdown and search results until you are ready for launch release day when piedpiper 25 5 0 is finalized and the software is released, you can publish it (optional) adjust the display order in space settings > version links of the main space you might want the new version to appear at the top of the list, or set as the default view for new visitors 4 content propagation & maintenance once created, space versions act as completely separate copies (forks) of the content they do not share a database for document content no automatic sync if you fix a typo, update a code snippet, or rewrite a paragraph in the main space ( 25 4 x ), that change does not automatically propagate to 25 5 0 or 25 6 0 manual updates you must apply content fixes manually to every active version that requires the change why is this beneficial? while this requires manual effort, it ensures stability it prevents a change intended for the latest api (v26 0) from accidentally breaking the documentation for a legacy api (v24 0) that relies on older behavior exception (ai translations) ai translations are designed to propagate changes across languages within a single version (e g , english to spanish within v25 4 x), but this mechanism does not cross the boundary between version branches 5 navigation and links linking is "version aware" archbee's linking system is intelligent enough to respect the version context the user is currently viewing relative navigation if a user is reading doc a in v25 5 0 and clicks a link to doc b , they will automatically be taken to the v25 5 0 copy of doc b they will not be bounced back to the main space context switching switching versions using the dropdown simply switches the context if the user is on "getting started" in v25 4, and switches to v25 5, the system attempts to keep them on the "getting started" page of the new version search behavior scope the global search bar indexes content from all currently published versions user control to prevent result clutter, readers can filter search results to see matches only from the version they are currently reading this helps users avoid finding v25 6 0 features when they are trying to troubleshoot a v25 4 x installation tips & tricks how to create social media links? right now, archbee doesn't have any feature related with social media links and a place dedicated for social media links but there is a workaround to create them first, hit the plus icon to create a new file in the desired space; convert the document into a link (find here / / /documents/convert to link md more details) click on the new link item to open the link menu write your label (e g linkedin, producthunt, etc ) paste your social media url in the second field hit done to finish it optionally, you can check the option "open in new tab" repeat the process as many times you need don't forget to publish the space after you finish to add your social links this method allows you to create custom links to any external social platform you choose directly in your document tree level you can also create them in the space links / / /hosted spaces/space links md tab from space settings to display them in the upper right corner of your documentation plaftform