DOCSEARCHbyAlgolia
Submit Docs

Fluna Documentation

website·Indexed 30 days ago

https://fluna-tech.github.io/fluna-docs/docs/v1

Engineering documentation for Fluna, featuring the Fluna Treasury flagship product. The site includes installation guides for the Fluna Docs Framework, release notes, changelogs, and technical tutorials on managing documentation versions and i18n configuration.

Tokens
3.1K
Snippets
28
Records
33
Agent score
75%

What's inside Fluna

  1. Overview of Fluna Treasury and its core modules

    v1

    Fluna Treasury is a financial ecosystem designed to power debt financing solutions and optimize financial operations. It is built as a modular system comprising the following core modules:

    • Auth Module: Handles authentication.
    • KYC Module: Manages Know Your Customer processes.
    • Onboarding Module: Manages user onboarding.
    • Settings Module: Handles system and user configurations.
    • Lending Module: Manages loan and debt financing operations.
    • Payments Module: Handles financial transactions and payments.
    • Mailing/Notification Module: Manages system communications and alerts.

  3. Overview of Fluna Engineering Documentation

    v1

    The Fluna Engineering documentation hub serves as the central source of truth for the organization's systems, processes, tools, and technologies. It is designed to support developer onboarding, centralize engineering knowledge, and ensure operational continuity. The documentation is structured into the following areas:

    • Systems Overview: Engineering architecture, core technologies, and integrations.
    • Modules: Details on components, libraries, and microservices.
    • API Documentation: Reference guides for public and internal APIs (endpoints, usage, and troubleshooting).
    • Development Guidelines: Coding, testing, and deployment standards.
    • Infrastructure: Cloud environments, CI/CD pipelines, and Infrastructure-as-Code (IaC) practices.
    • Team Processes: Agile workflows and sprint planning.
    • Knowledge Base: FAQs and troubleshooting resources.

  4. Create a new documentation version in Docusaurus

    Docusaurus allows you to maintain multiple versions of your documentation. To release a specific version (e.g., 1.0), use the docs:version command. This process copies the current docs folder into a new directory named versioned_docs/version-1.0 and generates a versions.json file to track the versions.

    After creating a version, the documentation is split into:

    • The released version (e.g., 1.0) available at /docs/.
    • The upcoming, unreleased version (labeled as current) available at /docs/next/.
    npm run docusaurus docs:version 1.0

  6. Use React components in Markdown via MDX

    Docusaurus supports MDX, allowing you to export and use React components directly within your Markdown files to create interactive documentation.
    export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !

  9. Install and run Fluna Docs Framework locally

    v1
    Follow these steps to clone the repository, install dependencies, and start the local development server. The server runs by default at http://localhost:3000 with hot-reloading enabled.
    # Clone the repository
git clone <YOUR_REPOSITORY_URL>
cd <PROJECT_NAME>

# Install dependencies
npm install

# Start the development server
npm run start

  10. Translate documentation files for a specific locale

    To translate a document, copy the original markdown file from the docs directory into the corresponding locale folder within the i18n directory. The path structure follows the plugin name and the 'current' version folder.
    # Example: Translating docs/intro.md to French (fr)
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md

  11. Update content for specific documentation versions

    Versioned documentation is managed in separate directories. To update a specific version, edit the files within the corresponding versioned_docs folder. To update the upcoming/unreleased version, edit files in the main docs folder.

    Example mapping:

    • versioned_docs/version-1.0/hello.md $\rightarrow$ updates http://localhost:3000/docs/hello
    • docs/hello.md $\rightarrow$ updates http://localhost:3000/docs/next/hello

  12. Set up the Fluna Docs Framework environment

    v1
    To use the Fluna Docs Framework, you must have Node.js version 18.0 or above installed. It is recommended to use nvm (Node Version Manager) to manage multiple Node versions. A code editor is also required; Webstorm is recommended.
    # Check your current Node version
node -v