Welcome to Viventio Technical Documentation
Welcome to Viventio's technical knowledge hub. This documentation has been created to help developers, architects, and technical team members understand our philosophy and values when it comes to software engineering.
About This Repository
This documentation book contains all essential knowledge about how we think about software engineering. Our goal is to ensure that the entire team understands this mindset of principles and values.
Documentation Structure
Our documentation is organized into two main areas:
Philosophy
Documentation about our philosophy, values, and principles.
- Exceptions and Try-Catch Blocks Considered Harmful - A rant about why we don't use exceptions to handle errors in our code.
Getting Started
If you're new to the Viventio codebase, we recommend following this learning path:
- Start with the Overview - Read the README files in both backend and frontend sections.
- Explore the philosophy - Understand the values and principles behind our development practices.
- Go to our internal documentation - If you're a Viventio contributor, request access to our internal documentation to learn more about architecture, code patterns and conventions, testing, and more.
How to Use This Documentation
- Browse by Topic - Use the structure above to navigate to specific areas.
- Search - Use your documentation tool's search feature to find specific topics.
- Contribute - Help keep this documentation up-to-date by submitting. improvements.
- Ask Questions - If something is unclear, reach out to the team.
How to get access to our internal documentation
If you're a Viventio contributor, you can request access to our internal documentation.
Access it using this Viventio Internal Documentation. If you see a 404 error, then you don't have access. I recommend you reach out to the CTO to get access.
Contributing
This documentation is a living resource that evolves with our systems. If you find gaps, errors, or opportunities for improvement, please contribute! Clear documentation benefits everyone on the team.
Support
For questions about this documentation or technical guidance, please reach out to Hícaro Dânrlley.
Maintained by: Hícaro Dânrlley - the CTO of Viventio.