In order to provide the best content for users this guide outlines how tutorials should be written on the site.
A tutorials must have a title and a description. The title should describe what the tutorial is about and should have the language name in it.
Some examples are shown below
- Getting Started with react ( php, javascript any lanauge)
- Building a blog with angular
- Connecting to a database in PHP
- Getting JSON data from github using ruby
- Getting data from an excel file using Python
The description should further expand on the title. The description can also be identical to the title. The description can phrase the title in a different way.
Some examples are shown below
- In this tutorial we look at how to setup a react application
- Building a blog with angular ( same as title)
- You can connect to a database in PHP using three methods ( more info )
- Using the github api to get a user profile json data.
Tutorials are separated by pages. Pages are sections in our tutorials and provide a great way to focus your tutorials. Think of your tutorial as a book. Each page as something new and interesting.
Usages of pages
- Hold your tutorial content. You can create a single page tutorial if you like.
- Hold code. You can add code samples in separate pages.
- Separate topics. You can separate your tutorial to make it more consumable.
- Its really up to you.
Pages have titles and descriptions as well. A page title describes the page. The description is option but can be useful.
Examples of titles and descriptions are shown below
- Setting up and react environment - Getting started
- app.js - The main javascript file
- Introduction - Lets get started working with ruby
- opencsv.py - The file used to open the csv files
Page content is where you