DjangoGirls / tutorial

This is a tutorial we are using for Django Girls workshops
http://tutorial.djangogirls.org/
Other
1.53k stars 1.86k forks source link

README Contribution Instruction is outdated #1726

Closed nikhiljohn10 closed 2 years ago

nikhiljohn10 commented 3 years ago

The README section for "New Content and Complex Changes" are outdated. Need to update the documentation.

Let us consider this documentation of GitBook and modify it for our requirements.

For example:

# Clone your forked repository
git clone git@github.com:yourgithubusername/tutorial.git
cd tutorial

# Create a new branch in your repo for contributing
git checkout -b contributing

# Install all required modules needed for running gitbook server locally
npm install

# To start-up preview server for local changes
npx honkit serve

# Your local server will be on http://localhost:4000

Any thoughts on a good draft of documentation for the same?