MISC
Glossary
44 min
glossary under construction 🚧 our glossary is a work in progress, but we're adding new definitions all the time stay tuned for more! a addon an additional feature or module that can be integrated into archbee to enhance its capabilities, such as the ai addon for advanced ai functionalities / /editor/editor blocks/api docs blocks/api endpoints md document your api endpoints with clarity, providing essential details for developers and users alike b / /editor/editor blocks md building blocks for your docs think of them as legos for your content you can use them to create headings, tables, images, code snippets, and more there are basic, media, developer, and embedded blocks to choose from / /editor/editor blocks/button md interactive buttons that link to other internal or external pages, guiding users through your documentation or your content outside the documentation c / /editor/editor blocks/callout md highlight important notes, tips, or warnings with visually distinct callouts to draw attention to key information / /editor/editor blocks/changelog md keep your users informed with a changelog block that documents updates and changes in your project / /editor/editor blocks/code editor multi language md a multi language code editor for showcasing code snippets, perfect for developers / /editor/editor blocks/code drawers md organize your code snippets in drawers and show them side by side with your conent, keeping your documentation tidy and user friendly / /editor/reusables/content snippets md create reusable blocks of content that can be inserted across multiple documents, ensuring consistency and saving time d e / /editor/how to use the editor md your go to place for creating and editing content it's like a digital workspace where you can use shortcuts, add different types of content blocks, and format your text using markdown or the wysiwyg menu you can even embed content from other tools and link to other documents think of it as your one stop shop for all things content creation! / /integrations/embed examples md integrate content from popular tools like loom, figma, and miro directly into your documentation for a cohesive experience / /editor/editor blocks/expandable headings md sections that can be expanded or collapsed, making it easy to navigate complex topics f / /editor/editor blocks/file md upload and link files directly within your documentation, making resources easily accessible to users / /editor/reusables/file manager md organize and manage all your files in one central location, making it easy to upload, access, and link resources within your documentation g / /editor/editor blocks/api docs blocks/graphql md document graphql apis effectively, providing users with the information they need to interact with your services h / /editor/editor blocks/headings md used to create titles and subtitles for organizing content hierarchically / /editor/editor blocks/horizontal divider md horizontal dividers helps you to create visual breaks between sections, enhancing the flow of your documentation i / /editor/editor blocks/image md enrich your documentation with images, adding visual context and engagement to your content j k l / /editor/editor blocks/link blocks md create dynamic links to other documents or external resources, facilitating easy navigation within your content / /editor/editor blocks/lists md utilize ordered and unordered lists to break down information into digestible points, improving readability m / /editor/editor blocks/map md integrate maps to display location based information, enhancing the relevance of your content / /editor/editor blocks/mermaid diagrams md create flowcharts and diagrams using the mermaid syntax, adding visual aids to your documentation / /editor/editor blocks/minitaskers md organize tasks into manageable subtasks with minitaskers, inspired by trello, to keep your projects on track n o p q r reusables create and manage reusable content blocks that can be inserted into multiple documents, ensuring consistency and saving time across your documentation s / /spaces/spaces md containers for documents organized by teams or projects each account has a personal space, and organizations can create custom ones with access control / /spaces/space group md think of them as folders for your spaces you start with one called "spaces " make more folders if you need them you can add, rename, or delete folders (but only if they're empty) to put a space in a folder, just drag it there, use the move action, or create it in the folder / /hosted spaces/space links md connect multiple published spaces for easy navigation between docs (e g , user guides, api docs) add links in space settings, label them, and publish changes to links automatically update across connected spaces / /editor/editor blocks/api docs blocks/openapi swagger block md seamlessly integrate openapi specifications to enhance your api documentation t / /editor/editor blocks/table md use table block to present data in a clear and organized manner, perfect for comparisons and structured information / /editor/editor blocks/tabs md organize content into multiple tabs for a clean and efficient navigation experience, allowing users to switch between topics easily / /editor/editor blocks/tex ecuation md render complex mathematical equations using tex, making your documentation suitable for technical subjects u user groups are like departments for your users you can create different groups (like engineers, marketing, or management) and assign users to them this helps you organize your users and give them different access levels to different parts of your organization v / /editor/editor blocks/vertical split md showcase content side by side with the vertical split block, ideal for comparisons or related information / /editor/editor blocks/video md embed videos from https //www youtube com and / /integrations/embed examples/loom md platforms to provide dynamic content and tutorials directly within your documentation w / /editor/editor blocks/workflow\ md visualize processes and workflows with this block, helping users understand steps and sequences clearly / /editor/wysiwyg menu md a user friendly "what you see is what you get" menu that allows you to format your content visually, making document creation intuitive and straightforward x y z