Skip to main content

About Docs

Intention​

While I can't memorize everything I've learned, I'd like be able to reference useful information on demand.

The intention of these Docs were to serve me as my personal collection of notes and references: clear and concise, but I've decided to make these notes public in case someone else might also find them helpful.

Disclaimer​

As technologies are always evolving, official documentations should always include the most up-to-date information.

That is until you find that the official docs are lacking in one way or another. Or, sometimes it's just hard (harder) to find the specific info you're looking for, whether it's from the official docs or a Stack Overflow article. This is where my docs can be helpful.

I may prefer to organize and jot down some notes that I find useful, in a way that's clear to me. If you find any of these notes helpful, I'll be super happy that I've saved you some amount of time or helped you understand something better.

Even though the articles contents may includes random issues and solutions and may be out-of-context, I do think they might be helpful to others. When I have time, I'd be happy to update and improve my notes.

Story Time: Confronting Imperfection​

Recognizing that creating good documentation is a meaningful but tedious task and documenting a lesson learned (concisely) requires patience and time to process and summarize the experience, I took some time to document some of my lessons learned and saved most of my notes without having them posted.

After a while though, I realized that these notes do not exist online. I'd reference my files, make small edits, and the notes are saved locally. This defeats the purpose of this Docs section of my site though. The perfectionist in me will require me to either (1) remove the Docs section because it will never be perfect, (2) have 2 somewhat helpful articles for a year (they are incomplete anyways, the intention is not to replace the official docs), or (3) post these random, incomplete notes, but I can still refer back to them, and they might possibly be helpful to someone.

So, I hope this can be helpful to you! If you would like to contribute, please feel free to create an issue on my GitHub repo so I can review it. You are also welcome to submit a PR to make it better! Please reach out or create an issue before you spend a huge amount of time on a PR. Here's a Contributing Guide.

:)