Documenting with Docusaurus Version 2 for beginners

Documenting is a way of showing what is done so that other people can learn, modify, create, design and share. Therefore, it serves as evidence for peoples to acquire new information on the internet.

Comment

Inspiration

Learning and sharing are two important elements to grow professionally. It is for this reason that I was motivated to participate in this competition, inspiring me to share my knowledge with other people who are passionate about technology and want to make a small contribution to society. I was also inspired by all those people who are starting in the world of programming, developing algorithms to show their creativity and what they are capable of worldwide.

Another inspiration I had was to build an example site using Docusaurus. For that I chose one of my favorite themes called OpenXR. Therefore, I found it very cool that while users learn to use Docusaurus they also learn about Virtual Reality topics.

What it does

To help generate new knowledge I have created a tutorial which is based on Docusaurus Version 2. All the documentation is available in my Github repository, which is published. This tutorial shows step by step what must be done to install, configure and deploy our website locally. Once we are satisfied with the work, the tutorial will guide you to be able to put the project in a Github repository and see what our website would look like on the internet. The images I have provided are very intuitive and I am sure they are very useful.

After the steps in the tutorial, two videos were also created that are available on YouTube where it is explained what the user must do to work with Docusaurus.

How I built it

The tutorial is designed based on people who have no experience at all working with Docusaurus version 2. It is for that reason that it is divided into sections. Each section is in charge of showing steps and requirements that must be followed for the correct execution. With the help of images, it allows you to express ideas and steps in a clearer, more precise and concise way. Allowing the tutorial to be very effective and efficient.

The construction of the tutorial was carried out by reviewing technical manuals and using simple language to convey clear ideas in each paragraph. In addition, sometimes it is very useful to make available images that show what we tried to express previously and therefore, the user will find images that are related in terms of modifying content directly in the files and those modifications are then shown on the web.

After explaining all the theory in the tutorial, I decided to create two videos. One is in Spanish and the other is in English. They were created in two languages with the aim of expanding the audience of people interested in learning about Docusaurus.

And finally, I built a site using docusaurus to demonstrate what can be done. In this case, the topic I decided on was OpenXR. Since I work creating applications for VR, it seems like a good topic to reference and build a site using Docusaurus to address the OpenXR topic.

The English version of the video can be consulted at this link: https://www.youtube.com/watch?v=OkMr8jmLyKU

And the Spanish version of the video can be consulted at this link: https://www.youtube.com/watch?v=yYkPs3Q9UQE&lc=Ugw5PIpH8ar8dFaky5d4AaABAg

Challenges I ran into

I think the main challenge I had was to create a tutorial that was capable of being as clear and precise for the audience that could read it. Another challenge was trying not to neglect some detail for the proper execution of all the steps. That means that a revision was made from the grammar and punctuation marks to the clarity of the sentences accompanied by the images that support it.

On the other hand, try to create some videos that were as explanatory as possible and that are possible to understand very easily. Creating both videos in different languages was another challenge to overcome.

Accomplishments that I'm proud of

I am very happy that the information I have provided based on my experience and knowledge can be rewarding for other people to generate new knowledge and learn about the use of information technologies. You really enjoy using the Markdown language to create fascinating things.

Another thing that I am proud of was collaborating with the Open Source community to demonstrate how these tools can be very useful to us. Creating a repository that is available to any user where it is known that they will find quality information is really gratifying because you know that you are helping to develop new knowledge in people.

Publishing the videos on YouTube gives me great satisfaction because I know that many users will be able to reproduce them and learn new knowledge.

What I learned

I learned that it is important to create a very well structured and elaborate tutorial for all types of audiences. My learning was based on and focused on the fact that the tutorial should be easy and understandable for anyone. It is for that reason that I learned to take care of every detail in this tutorial.

I also learned relevant aspects regarding the Markdown language and how you can have more organized information that later becomes an HTML format on the web. Another thing I learned is that thanks to the Markdown language, any change we make to the source code is immediately displayed on the web, which left me very surprised.

What's next for Documenting with Docusaurus Version 2 for beginners

Extend this tutorial to the intermediate or advanced level, where users can implement source code to see effective changes directly in the templates. Work with images, layout styles and incorporation of new elements in the template. I would also like to share the tutorial with developer communities and get some feedback. In order to continue growing the tutorial to make new information available.

Built With

+ 16 more
Share this project:

Updates