Glossary

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 api endpoints docid\ jwrgiytgiu8c 7ml3hna8 document your api endpoints with clarity, providing essential details for developers and users alike b editor blocks docid 6b0vtqtvunmp93e szq2p 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 button docid\ jdaxu7ibxba1jw3khorop interactive buttons that link to other internal or external pages, guiding users through your documentation or your content outside the documentation c callout docid\ c sjub ir1v0j8c bksmc highlight important notes, tips, or warnings with visually distinct callouts to draw attention to key information changelog docid\ s9kukiue8z2e4y1x4v1gb keep your users informed with a changelog block that documents updates and changes in your project code editor multi language docid dmwewv5w9ycnvmlcui53 a multi language code editor for showcasing code snippets, perfect for developers code drawers docid 9rc9lvirrezcwra8j4lit organize your code snippets in drawers and show them side by side with your conent, keeping your documentation tidy and user friendly content snippets docid 1ocdy lvhrvpzf35hwghu create reusable blocks of content that can be inserted across multiple documents, ensuring consistency and saving time d e how to use the editor docid\ gzkfiylzu2jxupcxqo7uq 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! embed examples docid\ ejegs visaok25 lby1x0 integrate content from popular tools like loom, figma, and miro directly into your documentation for a cohesive experience expandable headings docid\ ajpn6hemcswfb9rr4hdhz sections that can be expanded or collapsed, making it easy to navigate complex topics f file docid\ t1ky085lzcmkkp3h9eba upload and link files directly within your documentation, making resources easily accessible to users file manager docid\ xgobbcfl4dcvfc1hfk619 organize and manage all your files in one central location, making it easy to upload, access, and link resources within your documentation g graphql docid\ hcripofvmbp0pr3xj8mhj document graphql apis effectively, providing users with the information they need to interact with your services h headings docid\ ch1eclxgmlpa xazawy6u used to create titles and subtitles for organizing content hierarchically horizontal divider docid\ yuthnhc9mnprzrtwxpb4l horizontal dividers helps you to create visual breaks between sections, enhancing the flow of your documentation i image docid\ mfibzf9k ya8z3ldzq37v enrich your documentation with images, adding visual context and engagement to your content j k l link blocks docid\ z vgvwifbolvuazqd6vwm create dynamic links to other documents or external resources, facilitating easy navigation within your content lists docid\ d02 vq5gnbt sueqotq3g utilize ordered and unordered lists to break down information into digestible points, improving readability m map docid 6bl0kza7bb9rgcnylsws integrate maps to display location based information, enhancing the relevance of your content mermaid diagrams docid\ frhb6aopndkyyjeqdejlg create flowcharts and diagrams using the mermaid syntax, adding visual aids to your documentation minitaskers docid\ vyt5x0nyqupzgwz906r56 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 docid\ utknpnokl1oy vxi5i8jo containers for documents organized by teams or projects each account has a personal space, and organizations can create custom ones with access control space group docid 3wvwjdudfhtba4wz9vjch 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 space links docid\ cftsj1sefjjug3zsdlvqq 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 openapi/swagger block docid\ bkf0sksgsyaimm6ek1cpb seamlessly integrate openapi specifications to enhance your api documentation t table docid\ xismeqbpimgonzxhoohwz use table block to present data in a clear and organized manner, perfect for comparisons and structured information tabs docid\ niagbrri7rjfxxckkhd1c organize content into multiple tabs for a clean and efficient navigation experience, allowing users to switch between topics easily tex ecuation docid\ w4ky8zdzzgyounmtxulit 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 vertical split docid\ vtoi7mkpjhkcqcc4xoaty showcase content side by side with the vertical split block, ideal for comparisons or related information video docid\ b2ip7djzj3ghcrxc42ril embed videos from youtube and loom docid 3m8iifx1qcqmo4ngqb0ij platforms to provide dynamic content and tutorials directly within your documentation w workflow docid\ tngouv2y9 9ut1vnwhqxj visualize processes and workflows with this block, helping users understand steps and sequences clearly wysiwyg menu docid\ wbvfmf8cfyojgkqnrjvig 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