Welcome¶
Welcome to my personal documentation repository! This repo is a collection of the notes, guides, troubleshooting logs, and resources I use in my daily development. It includes everything from setting up full-stack applications to solving common errors.
The aim is not to create a general-purpose documentation that helps everyone, but rather something I can refer to when working on the same technologies or concepts in the future. This will provide verified code snippets and the correct way of doing things, avoiding trial and error, saving time, and increasing my efficiency in writing repeatable code. This allows me to focus on learning new things.
Note: This documentation does not contain everything I have learned. At times of urgency, I have not and may not document certain concepts or snippets. Hopefully, I will add them someday soon.
Folder Structure¶
Below is an overview of the folder structure and what each section contains:
/development
¶
This section contains detailed guides and documentation organised by various topics:
- setup: Setup of frontend, backend using typescript, react-native , etc tech stacks also of packages like mkdocs or tools like obsidian and many more.
- snippets: Working code snippets of the various packages or tools, etc.
- miscellaneous: Things that i could not classify are added to this section.
- deployment: Docs related to deployment like creating VM or hosting site on VM, using ngnix, etc.
/error-solutions
¶
A collection of error logs and their corresponding solutions:
- development-errors: Errors faced during development like cors or handling data, deployment etc.
- cpp-errors: cpp language errors that I usually find during dsa or cp.
/general
¶
Documentation specific to general things like involving OS or something
- ubuntu: Problems related to ubuntu.
/learning
¶
A section dedicated to learning resources and materials, docs that I created while learning:
- docker
- git-github
- mongodb
- react
- react-native
- typescript
- UI-Libraries-Frontend-Styling
/legacy-docs
¶
These are the docs that I created earlier, does contains some useful notes still but are not very well written or not classified correctly.
How to Use¶
Feel free to browse through the directories to find the specific documentation, error and solution, or resources that you need. Each folder is organized to make it easy to locate the relevant information.
Contribution¶
This repository is primarily for my personal use, but if you find something useful and would like to contribute or suggest improvements, feel free to create an issue or submit a pull request or directly mail me.