Welcome to STL Code Conventions 👋
Welcome to the official documentation for the Silverfin Templating Language, though often also referred to as Liquid. This guide is an essential resource for all developers, both internal and external, who develop on Silverfin. It outlines the standardized practices and guidelines that govern the formatting, syntax, data architecture, and platform specifics of STL code. Adhering to these conventions is crucial for maintaining code consistency, readability, and collaboration. 🤝
Adhering to STL Code Conventions isn't just a suggestion; it's a fundamental practice that yields substantial benefits:
- Improved Collaboration: When all developers follow the same conventions, it's easier to work together, share code, and maintain projects collectively.
- Reduced Errors: Consistent code formatting and syntax reduce the likelihood of coding errors, ultimately saving time and resources.
- Enhanced Readability: Code that adheres to conventions is more accessible, making it simpler for new team members and external developers to understand and contribute effectively.
- Long-term Maintainability: Code written following conventions is easier to maintain, reducing technical debt and ensuring the longevity of your STL projects.
Whether you're a seasoned developer or new to STL, adopting these code conventions is essential for ensuring code quality, readability, and collaboration. Start exploring each section to unlock the full potential of your templates.
Code Formatting is the cornerstone of clean and readable code. Consistent formatting practices increase the readability of your code, making it easier for developers to work together seamlessly. By following these conventions, you ensure that your code is accessible to everyone who interacts with it.
Code Syntax defines how you express logic and functionality in STL. Well-defined syntax rules not only make your code more predictable but also reduce the chances of errors and bugs. This section provides a comprehensive overview of the STL syntax rules and best practices to write efficient and maintainable code.
Data Architecture sits at the heart of every software system. In this section, you’ll learn best practices on how to design strong foundations for storing and organizing data on Silverfin. Think of templates as building blocks that need to work together smoothly, like puzzle pieces fitting together. If you we get this part right, it makes your workflows easy to grow and trust, which is crucial for everyone using and maintaining the templates.
This part of the code conventions actually doesn’t necessarily relate to just the code. There are some aspects that you as a liquid developer need to understand to ensure your code works seamlessly on the Silverfin platform. You’ll learn some best practices regarding template development in general, from configuration to PDF export.
Updated about 2 months ago