# platformOS Documentation > The official documentation portal for platformOS, covering API reference, tutorials, best practices and developer guides. This manifest provides a structured index of the most important publicly available documentation pages. Links generally point to Markdown versions of the docs when available, making it easier for LLMs and AI agents to fetch clean, parseable content. Use this list to navigate or build context for code generation, summarization, or question-answering tasks. ## API Reference > Explore APIs existing in platformOS - [Liquid - Tags: doc](https://documentation.platformos.com/api-reference/liquid/doc.md): (markdown) The doc tag lets you document partial parameters inline so that platformOS Check and editor tools can validate and autocomplete them. - [Liquid - Filters](https://documentation.platformos.com/api-reference/liquid/filters.md): (markdown) Liquid filters - [Liquid - Tags: Flow Control](https://documentation.platformos.com/api-reference/liquid/flow-control.md): (markdown) Liquid Tags - Flow Control - [Liquid - Tags: render / include](https://documentation.platformos.com/api-reference/liquid/include.md): (markdown) Liquid Tags — render and include: rendering partials in platformOS - [Liquid Markup - Introduction](https://documentation.platformos.com/api-reference/liquid/introduction.md): (markdown) Introduction to Liquid Markup - [Liquid - Tags: Loops](https://documentation.platformos.com/api-reference/liquid/loops.md): (markdown) Liquid Tags - Loops - [Liquid - Objects](https://documentation.platformos.com/api-reference/liquid/objects.md): (markdown) Liquid - Objects - [Liquid - platformOS Liquid Filters](https://documentation.platformos.com/api-reference/liquid/platformos-filters.md): (markdown) platformOS Liquid Filters - [Liquid - platformOS Objects](https://documentation.platformos.com/api-reference/liquid/platformos-objects.md): (markdown) Liquid - platformOS Objects - [Liquid - platformOS Liquid Tags](https://documentation.platformos.com/api-reference/liquid/platformos-tags.md): (markdown) platformOS Liquid Tags - [Liquid - Data Sanitization](https://documentation.platformos.com/api-reference/liquid/sanitization.md): (markdown) How to data is sanitized by default in Liquid - [Liquid - Tags: Theme](https://documentation.platformos.com/api-reference/liquid/theme.md): (markdown) Liquid Tags - Theme - [Liquid - Types](https://documentation.platformos.com/api-reference/liquid/types.md): (markdown) Liquid Types - [Liquid - Tags: Variables](https://documentation.platformos.com/api-reference/liquid/variables.md): (markdown) Liquid - Variables - [Liquid - Whitespace Control](https://documentation.platformos.com/api-reference/liquid/whitespace-control.md): (markdown) Liquid - Whitespace Control - [Partner Portal API](https://documentation.platformos.com/api-reference/partner-portal/api.md): (markdown) This documentation will help you manage your instances programmatically using Partner Portal API. - [Partner Portal DNS API Documentation](https://documentation.platformos.com/api-reference/partner-portal/api/dns.md.md): (markdown) This documentation will help you manage your instance domains programmatically using Partner Portal API. ## Best Practices > Get expert advice on platformOS best practices in a wide variety of topics. - [Building AMP Pages on platformOS](https://documentation.platformos.com/best-practices/amp/building-amp-pages.md): (markdown) Building AMP pages on platformOS: standard, benefits, and tutorials to get you started. - [Converting AMP HTML Pages to Layouts and Pages](https://documentation.platformos.com/best-practices/amp/converting-amp-html-layouts-pages.md): (markdown) This guide will help you convert a static theme file into layouts and pages to be used as platformOS components. - [Feeding Data into AMP Pages with GraphQL](https://documentation.platformos.com/best-practices/amp/feeding-data-amp-pages-graphql.md): (markdown) This guide will help you feed data into your AMP pages using GraphQL. - [Using a Static AMP Template](https://documentation.platformos.com/best-practices/amp/using-static-amp-template.md): (markdown) This guide will help you use a static template (downloaded from the Internet as a zip file) on your platformOS site. - [Background Jobs](https://documentation.platformos.com/best-practices/backend-performance/background-jobs.md): (markdown) In this article, we share our experience on how you can improve your application performance by utilizing our background Liquid tag. - [Dynamic Page Cache](https://documentation.platformos.com/best-practices/backend-performance/dynamic-cache.md): (markdown) Detailed description of dynamic page cache, with examples. - [Fragment Cache](https://documentation.platformos.com/best-practices/backend-performance/fragment-cache.md): (markdown) Detailed description of fragment caching with examples. - [Measuring Execution Time of Liquid Code](https://documentation.platformos.com/best-practices/backend-performance/measuring-execution-time-liquid-time-diff.md): (markdown) This guide will help you measure the execution time of Liquid code fragments using the time_diff filter. - [Static Cache](https://documentation.platformos.com/best-practices/backend-performance/static-cache.md): (markdown) Detailed description of static cache, with examples. - [Installing TestCafe](https://documentation.platformos.com/best-practices/end-to-end-testing/installing-testcafe.md): (markdown) This guide will help you install TestCafe for automated end-to-end web testing. - [Using the Page Object Model with TestCafe](https://documentation.platformos.com/best-practices/end-to-end-testing/using-pom-testcafe.md): (markdown) This guide will help you use the Page Object Model (POM) pattern with TestCafe. - [Writing a TestCafe Test](https://documentation.platformos.com/best-practices/end-to-end-testing/writing-testcafe-test.md): (markdown) This guide will help you write your first test using TestCafe. This tutorial uses an example from the platformOS documentation site. - [Code Quality and Performance Best Practices](https://documentation.platformos.com/best-practices/frontend-performance/code-quality-performance.md): (markdown) In this article, we share our experience on how you can improve the code quality of your platformOS site, and test and improve performance. You’ll find best practices, examples of what not to do, and tips for tools to use. - [Embedding Youtube Videos](https://documentation.platformos.com/best-practices/frontend-performance/embedding-youtube-videos.md): (markdown) How to embed a Youtube video while keeping your page fast and your users' privacy intact. - [Lazy Loading of Fragments](https://documentation.platformos.com/best-practices/frontend-performance/fragment-lazy-loading.md): (markdown) In this article, we share a frontend technique that can be used to mitigate a performance issue until it's resolved permanently. - [Monitoring Website Performance Using Lighthouse-CI](https://documentation.platformos.com/best-practices/frontend-performance/monitoring-website-performance-using-lighthouse-ci.md): (markdown) How to set up monitoring to make sure you don't miss any performance regressions. - [Optimizing Font Files](https://documentation.platformos.com/best-practices/frontend-performance/optimizing-font-files.md): (markdown) How to make your font files small and load fast - [Optimizing Image Files](https://documentation.platformos.com/best-practices/frontend-performance/optimizing-image-files.md): (markdown) In this article you can learn about the steps we are going through when preparing images for our web properties. - [Service Workers](https://documentation.platformos.com/best-practices/frontend-performance/service-workers.md): (markdown) This topic describes what service workers are and how to use them in platformOS. - [GDPR Compliance in platformOS](https://documentation.platformos.com/best-practices/gdpr/gdpr-compliance.md): (markdown) Detailed information on GDPR compliance with examples. - [GDPR Technical Implementation in platformOS](https://documentation.platformos.com/best-practices/gdpr/gdpr-technical-implementation.md): (markdown) Examples of technical implementation of GDPR. - [Creating Application Logs](https://documentation.platformos.com/best-practices/qa/creating-application-logs.md): (markdown) This guide will help you create your own application logs using the `log` Liquid tag. - [Creating Test Cases and Executing Tests](https://documentation.platformos.com/best-practices/qa/creating-executing-tests.md): (markdown) This guide will help you create and execute tests. - [How We Built Our QA Process](https://documentation.platformos.com/best-practices/qa/how-we-built-our-qa-process.md): (markdown) An in-depth look behind the scenes of our QA process including how we built and refined our process, the approaches we follow, and the tools we use. - [Planning, Organizing, and Writing Tests](https://documentation.platformos.com/best-practices/qa/planning-organizing-writing-tests.md): (markdown) In this article we explore some best practices for planning, organizing, and writing your tests. - [Speeding Up Development and Troubleshooting](https://documentation.platformos.com/best-practices/qa/speeding-up-development-troubleshooting.md): (markdown) Some tips on speeding up development and troubleshooting. - [Testing](https://documentation.platformos.com/best-practices/qa/testing.md): (markdown) Recommendations for testing your platformOS site. - [Creating a Dynamic Sitemap](https://documentation.platformos.com/best-practices/seo/creating-dynamic-sitemap.md): (markdown) This guide will help you create a dynamic /sitemap.xml page. - [Creating SEO Friendly URLs](https://documentation.platformos.com/best-practices/seo/creating-seo-friendly-urls.md): (markdown) This guide will help you create SEO friendly URLs by walking you through an example. - [Preventing Duplicated Content](https://documentation.platformos.com/best-practices/seo/preventing-duplicated-content.md): (markdown) This best practice explains how platformOS prevents the indexing of non-production sites to avoid the website being flagged as duplicated content. ## Developer Guide > This section provides **detailed descriptions of concepts, step-by-step tutorials, references, and examples** for implementing various features on platformOS. - [What is platformOS?](https://documentation.platformos.com/developer-guide/about-platformos/about-platformos.md): (markdown) An overview of the main features and technologies of platformOS. - [Security and Disaster Recovery](https://documentation.platformos.com/developer-guide/about-platformos/security-drp.md): (markdown) This article outlines the steps platformOS takes to ensure security and provide disaster recovery. - [Activity Feeds](https://documentation.platformos.com/developer-guide/activity-feeds/activity-feeds.md): (markdown) A description of activities and activity feeds with examples. - [Handling Read Activities](https://documentation.platformos.com/developer-guide/activity-feeds/handling-read-activities.md): (markdown) This guide will help you handle an unread counter and mark your activites as read. - [Creating Items from an External API Call](https://documentation.platformos.com/developer-guide/apis/creating-items-from-external-api-call.md): (markdown) This guide will help you create items from an external API call. The example shows the steps of creating a Record from existing data through an API call to our service. - [Persisting Part of a Third-Party API Response](https://documentation.platformos.com/developer-guide/apis/persisting-part-of-third-party-api-response.md): (markdown) This guide will help you persist part of a third-party API response by walking you through an example. - [Adding Visuals to Pages: CSS](https://documentation.platformos.com/developer-guide/assets/adding-visuals-pages-css.md): (markdown) This guide will help you add visuals (images) to your pages using a CSS file, and accessing and displaying the image through its relative path. - [Adding Visuals to Pages: Javascript](https://documentation.platformos.com/developer-guide/assets/adding-visuals-pages-javascript.md): (markdown) This guide will help you add visuals (images) to your pages using Javascript. - [Assets](https://documentation.platformos.com/developer-guide/assets/assets.md): (markdown) Assets are files that can be served by an http web server without any backend/server processing. They are usually Javascript files, stylesheets (CSS), images, documents (pdf, doc), fonts, or media (audio, video) files. - [Using Static Assets on Your Pages](https://documentation.platformos.com/developer-guide/assets/using-static-assets-pages.md): (markdown) This guide will help you use static assets (e.g. CSS, Javascript, or HTML files) on your pages. - [Adding an Authorization Policy](https://documentation.platformos.com/developer-guide/authorization-policy/adding-authorization-policy.md): (markdown) This guide will help you add an Authorization Policy. - [Associating an Authorization Policy with Form](https://documentation.platformos.com/developer-guide/authorization-policy/associating-authorization-policy-form.md): (markdown) This guide will help you associate an Authorization Policy with Form. - [Associating an Authorization Policy with a Page](https://documentation.platformos.com/developer-guide/authorization-policy/associating-authorization-policy-page.md): (markdown) This guide will help you associate an Authorization Policy with a page. - [Authorization Policy](https://documentation.platformos.com/developer-guide/authorization-policy/authorization-policy.md): (markdown) Authorization Policies allow you to restrict access to forms and pages in a flexible way. Each form and page can have multiple policies attached to it. - [Handling a Violated Authorization Policy](https://documentation.platformos.com/developer-guide/authorization-policy/handling-violated-authorization-policy.md): (markdown) This guide will help you handle a violated Authorization Policy. - [Blog Settings and Posts](https://documentation.platformos.com/developer-guide/blog/blog-settings-posts.md): (markdown) Detailed information on blog settings and posts with examples. - [Creating a Blog Post](https://documentation.platformos.com/developer-guide/blog/creating-blog-post.md): (markdown) This guide will help you add a post to your blog. - [Installing the Blog Module](https://documentation.platformos.com/developer-guide/blog/installing-blog-module.md): (markdown) This guide will help you install the platformOS Blog Module. - [CI Introduction](https://documentation.platformos.com/developer-guide/ci-cd/ci-cd.md): (markdown) TODO - [Setting Up a Release Pool](https://documentation.platformos.com/developer-guide/ci-cd/set-up-release-pool.md): (markdown) Follow the steps of this tutorial to set a Release pool for CI/CD. - [Data Export](https://documentation.platformos.com/developer-guide/data-import-export/export.md): (markdown) Detailed description of data export with examples. - [Data Import using CSV format](https://documentation.platformos.com/developer-guide/data-import-export/import.md): (markdown) Detailed description of data import with examples. - [Data Export to JSON](https://documentation.platformos.com/developer-guide/data-import-export/json-export.md): (markdown) Detailed description of data export to JSON format with examples. - [Migrating Data](https://documentation.platformos.com/developer-guide/data-import-export/migrating-data.md): (markdown) This guide will help you use migrations when you need to change the data or execute a piece of code outside of the regular application running cycle. - [Cleaning an Instance](https://documentation.platformos.com/developer-guide/data-management/cleaning-instance.md): (markdown) This guide will help you use the `pos-cli` to clean data on your Instance. - [Embeddings](https://documentation.platformos.com/developer-guide/embeddings/embeddings.md): (markdown) Leverage AI in your application - [Default Payload](https://documentation.platformos.com/developer-guide/forms/default-payload.md): (markdown) The `default_payload` option in Forms allows you to provide default request parameters as JSON. - [Form Examples](https://documentation.platformos.com/developer-guide/forms/examples.md): (markdown) A collection of Form examples. - [Flash Messages](https://documentation.platformos.com/developer-guide/forms/flash-messages.md): (markdown) Flash messages are used to create notices and alerts, e.g. on form submission. - [Form Configuration Options](https://documentation.platformos.com/developer-guide/forms/form-configuration.md): (markdown) An overview of form configuration options. - [Form Rendering](https://documentation.platformos.com/developer-guide/forms/form-rendering.md): (markdown) Form Rendering in platformOS. - [Forms](https://documentation.platformos.com/developer-guide/forms/forms.md): (markdown) Basic concepts of forms in platformOS with examples. - [Form Server-Side Processing](https://documentation.platformos.com/developer-guide/forms/form-server-side-processing.md): (markdown) Form Server-Side Processing in platformOS. - [Form Validation](https://documentation.platformos.com/developer-guide/forms/validation.md): (markdown) Form Validation gives you full control over the data format accepted by the form. - [Glossary](https://documentation.platformos.com/developer-guide/glossary.md): (markdown) Alphabetical list of platformOS-related terms. - [Support Ticketing with platformOS](https://documentation.platformos.com/developer-guide/support-ticketing.md): (markdown) Ways to contact platformOS to send in questions, issues, or feature requests. ## Get Started - Introduction > Follow these step-by-step tutorials to set up your development environment and deploy your first platformOS site. ### Build Your First App > Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [Building the User Interface](https://documentation.platformos.com/get-started/build-your-first-app/building-the-user-interface.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [Removing Data from the Database](https://documentation.platformos.com/get-started/build-your-first-app/removing-data-from-the-database.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [Retrieving and Presenting the Data on the Page](https://documentation.platformos.com/get-started/build-your-first-app/retrieving-and-presenting-the-data-on-the-page.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [Saving Data to the Database](https://documentation.platformos.com/get-started/build-your-first-app/saving-data-to-the-database.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [Sending Email Notifications](https://documentation.platformos.com/get-started/build-your-first-app/sending-email-notifications.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. - [User Authentication](https://documentation.platformos.com/get-started/build-your-first-app/user-authentication.md): (markdown) Follow these step-by-step tutorials to build a simple To Do List application on platformOS. ### Introduction & Quick Start Guide > Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Building the User Interface](https://documentation.platformos.com/get-started/contact-us-tutorial/building-the-ui.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Defining the Email](https://documentation.platformos.com/get-started/contact-us-tutorial/defining-the-email.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Handling Invalid Input](https://documentation.platformos.com/get-started/contact-us-tutorial/handling-invalid-input.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Handling Valid Input](https://documentation.platformos.com/get-started/contact-us-tutorial/handling-valid-input.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Implementing Business Rules Using Commands](https://documentation.platformos.com/get-started/contact-us-tutorial/implementing-business-rules.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Redirecting and Displaying a Thank you Message](https://documentation.platformos.com/get-started/contact-us-tutorial/redirecting-thank-you.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Saving Data to the Database](https://documentation.platformos.com/get-started/contact-us-tutorial/saving-data-to-the-database.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Setting Up a Schema](https://documentation.platformos.com/get-started/contact-us-tutorial/setting-up-a-schema.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Setting Up an Endpoint and Understanding Files Structure](https://documentation.platformos.com/get-started/contact-us-tutorial/setting-up-endpoint.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Setting Up Form Submission to Trigger a POST Request](https://documentation.platformos.com/get-started/contact-us-tutorial/setting-up-form-submission.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Testing validation logic in contacts/create command](https://documentation.platformos.com/get-started/contact-us-tutorial/testing-contact-create-command.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Understanding and Using Context](https://documentation.platformos.com/get-started/contact-us-tutorial/understanding-context-params.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Styling the Form](https://documentation.platformos.com/get-started/contact-us-tutorial/using-common-styling.md): (markdown) Learn how to apply the Common Styling module to your Contact Us form for a professional, accessible design. - [Using Events to Send Confirmation Email](https://documentation.platformos.com/get-started/contact-us-tutorial/using-events.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Using Partials for Better Code Maintenance](https://documentation.platformos.com/get-started/contact-us-tutorial/using-partials.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Using the Build Command](https://documentation.platformos.com/get-started/contact-us-tutorial/using-the-build-command.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Using the Check Command](https://documentation.platformos.com/get-started/contact-us-tutorial/using-the-check-command.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Using the log Tag for Debugging](https://documentation.platformos.com/get-started/contact-us-tutorial/using-the-log-tag.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Using Message Length and Email Validators](https://documentation.platformos.com/get-started/contact-us-tutorial/using-validators.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Error Handling and Troubleshooting](https://documentation.platformos.com/get-started/error-handling.md): (markdown) Follow these step-by-step tutorials to build a Contact Us form on platformOS - [Installation and Configuration](https://documentation.platformos.com/get-started/installation-and-configuration.md): (markdown) Follow these step-by-step tutorials to set up your development environment and deploy your first platformOS site. - [What is platformOS?](https://documentation.platformos.com/get-started/platformos-overview.md): (markdown) Learn what platformOS is- a fully managed, multi-tenant development platform with powerful abstraction layers like Liquid, GraphQL, and YAML, designed to build customizable, secure, and extensible SaaS applications - [Why Liquid, GraphQL and YAML?](https://documentation.platformos.com/get-started/why-liquid.md): (markdown) Learn why platformOS uses Liquid, GraphQL, and YAML as its core abstraction layers - [Working with the Code and Files](https://documentation.platformos.com/get-started/working-with-the-code-and-files.md): (markdown) Follow these step-by-step tutorials to set up your development environment and deploy your first platformOS site. - [Your platformOS Toolkit](https://documentation.platformos.com/get-started/your-pos-toolkit.md): (markdown) Get familiar with the core tools and technologies of the platformOS development workflow ## platformOS Kits > A system of premade starter kits you can use out of the box to fast track scalable real-world applications for certain project types, or combine different elements and then customize them to build any application your customer needs. - [platformOS CommunityKit Business Logic](https://documentation.platformos.com/kits/communitykit/communitykit-business-logic.md): (markdown) Detailed description of each CommunityKit feature. - [platformOS CommunityKit](https://documentation.platformos.com/kits/communitykit/communitykit-introduction.md): (markdown) The platformOS CommunityKit provides an out of the box solution for building a community site on platformOS. - [Color Variants](https://documentation.platformos.com/kits/ui/color-variants.md): (markdown) The platformOS DesignKit uses Color Variants that are collected in the Style Guide part of the DesignKit. - [Features](https://documentation.platformos.com/kits/ui/features.md): (markdown) The platformOS Component Library has great design features, which makes working with the Library efficient for UX and UI designers. - [The platformOS Component Library](https://documentation.platformos.com/kits/ui/platformos-component-library.md): (markdown) The platformOS Component Library is a comprehensive collection of premade user interface elements. - [The platformOS DesignKit](https://documentation.platformos.com/kits/ui/platformos-design-kit.md): (markdown) This article introduces the content of our DesignKit in Figma and describes the methodology of how we built and organized it. - [Setting Your Brand Colors in the Component Library](https://documentation.platformos.com/kits/ui/setting-your-brand-colors.md): (markdown) This topic describes how you can change the out-of-the-box brand colors of the Component Library to your own brand colors using Figma. - [Setting Your Brand Fonts in the Component Library](https://documentation.platformos.com/kits/ui/setting-your-brand-fonts.md): (markdown) This guide will help you set your brand font types in the Component Library to use instead of the out-of-the-box fonts. - [Setting Your Logo in the Component Library](https://documentation.platformos.com/kits/ui/setting-your-logo.md): (markdown) This guide will help you set your logo for all the screens in the Component Library. - [User Research in Your Projects](https://documentation.platformos.com/kits/ux/user-research-in-your-projects.md): (markdown) Why to do user research, what are the benefits. ## Tutorials > This section contains step-by-step tutorials to help you implement various features on platformOS. ### Build an User Management Application > Follow these step-by-step tutorials to build an example user management application using pOS User Module. - [Adding an Admin Page](https://documentation.platformos.com/tutorials/user-management/add-admin-page.md): (markdown) Create an admin page and prepare it for role-based access control using the platformOS User Module. - [Assigning Roles to Users](https://documentation.platformos.com/tutorials/user-management/assign-roles.md): (markdown) Learn how to grant roles to user profiles so they can access protected pages and perform authorized actions. - [Testing the Authentication Flow](https://documentation.platformos.com/tutorials/user-management/authentication-flow.md): (markdown) Verify that your authentication setup works correctly by walking through the login and logout flow in your example application. - [Authorization with the can_do helper](https://documentation.platformos.com/tutorials/user-management/authorization-can-do.md): (markdown) Learn how to protect pages and actions using permissions and authorization helpers from the User Module. - [Creating a User Account](https://documentation.platformos.com/tutorials/user-management/create-account.md): (markdown) Learn how to create a user account using the built-in registration flow of the platformOS User Module. - [Creating Navigation and Loading the Current Profile](https://documentation.platformos.com/tutorials/user-management/create-navigation-current-profile.md): (markdown) Learn how to add navigation links and dynamically show Login and Logout options using the User Module. - [Displaying the Admin link based on permissions](https://documentation.platformos.com/tutorials/user-management/display-admin-permission.md): (markdown) Learn how to hide or show the Admin navigation link based on authentication state and permissions. - [Roles and Permissions](https://documentation.platformos.com/tutorials/user-management/roles-and-permissions.md): (markdown) Learn how platformOS handles roles, permissions, and profile-based authorization, and prepare your project for custom access control. - [Understanding User Module Endpoints](https://documentation.platformos.com/tutorials/user-management/understand-endpoints.md): (markdown) Learn about the endpoints that come with the platformOS User Module ## Use Cases > Explore how to implement real-life use cases. - [Authenticating a User with a JSON Web Token (JWT)](https://documentation.platformos.com/use-cases/authenticating-user-with-jwt.md): (markdown) This guide will help you authenticate JSON requests with a JSON Web Token (JWT). - [Building a Blog on platformOS](https://documentation.platformos.com/use-cases/building-blog.md): (markdown) Use case of building a blog on platformOS using the Blog Module: architecture, features, and tutorials to get you started. - [Connecting an Angular Single Page Application (SPA) with platformOS](https://documentation.platformos.com/use-cases/connecting-angular-spa-platformos.md): (markdown) This use case describes how to connect your Angular app (created with a CLI) with platformOS. - [Extracting Data Out of a PDF](https://documentation.platformos.com/use-cases/extracting-data-out-of-a-pdf.md): (markdown) This use case describes how we leveraged platformOS and DocParser to extract and import product data from hundreds of PDFs. - [Implementing Social Media Preview Cards](https://documentation.platformos.com/use-cases/implementing-social-media-preview-cards.md): (markdown) Implementing Social Media Preview Cards - [Improving the User Experience of Remote Documentation](https://documentation.platformos.com/use-cases/improving-ux-remote-documentation.md): (markdown) How we improved the UX of discovering and using our API Reference documentation by moving rendering from the client-side to the server-side. - [Node.js Debug Logging](https://documentation.platformos.com/use-cases/nodejs-debug-logging.md): (markdown) While working on node.js programs, you often need to print some additional info on the screen to know what exactly is happening during the flow. In this article we will show you how you can improve your logging in a very simple way. - [Optimizing SVG Exported from Figma](https://documentation.platformos.com/use-cases/optimizing-svg-exported-from-figma.md): (markdown) This use case describes how to export a flow diagram in SVG format from Figma and optimize its source code to make it smaller and easier to maintain. - [Recording Your Terminal to SVG](https://documentation.platformos.com/use-cases/recording-your-terminal-to-svg.md): (markdown) This use case describes how we recorded the pos-cli introduction and saved it as an SVG to embed it on our marketing website. - [Setting Up Twilio Video Integration](https://documentation.platformos.com/use-cases/twilio-video-integration.md): (markdown) Setup Twilio video integration for allowing users to engage in video conferencing. - [Using Gatsby with platformOS](https://documentation.platformos.com/use-cases/using-gatsby-with-platformos.md): (markdown) This use case describes how to configure Gatsby to work with platformOS. - [Using Liquid Markup in YAML](https://documentation.platformos.com/use-cases/using-liquid-markup-yaml.md): (markdown) This use case describes the recommended syntax when using Liquid markup in YAML in platformOS. - [Using REST Endpoints with a React App](https://documentation.platformos.com/use-cases/using-rest-endpoints-with-react.md): (markdown) This use case describes how to use platformOS as a REST backend service for a React app. - [Using WebSockets with platformOS](https://documentation.platformos.com/use-cases/using-websockets.md): (markdown) This guide will help you integrate WebSockets into your application.