Skip to content
Looplex Docs

Convention Policy for Documentation Pages

Looplex follows a consistent naming convention or namespace for its documentation portal. Looplex’s URL pages on “https://docs.looplex.com.br/” follows a hierarchical structure that includes the following components:

  1. Domain name: “https://docs.looplex.com.br/” is the domain name of the website.

  2. Language code: Use the two-letter language code to specify the language of the content. For example, “pt-br” represents Brazilian Portuguese.

  3. Topic folder: Use a descriptive topic folder to indicate the main category of the content. In this case, “legal”, “business”, and “technical” are the topic folders that you have chosen to organize your content. You may add more topic folders if needed, but make sure they are relevant and descriptive.

  4. Section name: Use a descriptive section name to indicate the sub-category or section of the content within the topic folder. For example, “conceptual-guides”, “entities-overview”, “getting-started”, “troubleshooting”, etc.

  5. Page name: Use a descriptive page name to indicate the specific content of the page. For example, “computational-law-and-expert-systems”, “overview”, “installation-guide”, “common-issues”, etc.

In addition to the hierarchical division, we follow these principles:

  • We use the standard internationalization convention and localization i18n) for identifying language and local content. The default language is pt-br, and the default foreign language is en-US, but we may have documentation in different languages and respective date formats, numerical separators etc..

  • When creating a new documentation page, keep the page names concise and informative, and avoid using special characters or spaces. Use hyphens (-) to separate words.

This will help users easily navigate and find the content they need. Here are a few examples of URLs using this naming convention:

NOTE: due to the limitations of our current Gatsby static page setup, we have temporarily divided our pages differently from our intended naming convention. Our legal documentation is hosted on “docs.looplex.com.br/legal”, our business-related content can be found on “learn.looplex.com.br/business”, and our technical documentation is located on “kb.looplex.com.br/technical”. However, we plan to migrate our documentation pages to our new website hosted on docs.looplex.com.br using IBM’s Carbon website on Gatsby. Once we have completed the migration, we will adhere to our intended naming convention which includes a division between the section name and the page name. This will help users easily navigate our documentation and find the content they need.

Help Desk Pages

Overall, Looplex’s support pages follow a similar naming convention to its documentation pages, using a hierarchical structure that includes the domain name, language code, topic folder, section name, and page name. However, Looplex also uses local domain names for its support pages to provide localized support for its customers.

For example, the support page for Looplex Cases is located at https://suporte.looplex.com.br/pt-br/cases and follows the same hierarchical structure as the documentation pages, with the domain name, language code, topic folder, section name, and page name. But the moniker (suporte.looplex) is in pt-br, since the vast majority of our users are in Brazil.

In addition to the main domain, Looplex also uses local domain names for its support pages, such as ” https://support.looplex.com/en-us/cases” for United States or https://support.looplex.com/es-es for products and services in the Spanish language. These local domain names serve the same purpose as the main domain, but are localized for specific regions and languages.

Looplex main webpage

The naming policy for Looplex’s main webpage, www.looplex.com.br does not follow a hierarchical structure like the documentation and support pages. Instead, it uses a simple and concise domain name that represents the company’s brand. From the main page, Looplex segregates its subpages by using a combination of top-level navigation menus and dropdown menus.

The structure of the menus remains the same across different versions of the website, but the menu items and subpages may be presented in different languages for localized versions. Overall, the naming policy for Looplex’s main webpage is based on a simple domain name and a navigational structure that allows users to easily find the subpages they need.

In addition to the top-level navigation menu, Looplex also uses a search bar on the main page where users can enter keywords to find specific pages or products. This search bar can also help users find subpages related to a particular topic.

For localized versions of the Looplex website, such as https://www.looplex.com/en-us, the top-level navigation menu and dropdown menus are often translated into the local language to better serve users in that region. The structure of the menus remains the same, but the menu items and subpages may be presented in a different language.