This is the repository for the Frappe Framework Documentation. Learn more about Frappe Framework on the official website and the GitHub repository.
This documentation is hosted on https://frappeframework.com/docs.
To create a local working copy of the documentation (primarily for purposes of contributing to the documentation):
- Install
benchand setup afrappe-benchdirectory by following the Installation Steps. - Start the server by running
bench start. - In a separate terminal window, create a new site by running
bench new-site frappeframework.test. - Run
bench get-app frappe_docs. - Run
bench --site frappeframework.test install-app frappe_docs. - Now open the URL http://frappeframework.test:8000/docs in your browser, you should see the Frappe Framework Documentation.
- Go to the
apps/frappe_docsdirectory of your installation and executegit pull --unshallowto ensure that you have the full git repository. Also fork thefrappe/frappe_docsrepository on GitHub. - Check out a working branch in git (e.g.
git checkout -b my_doc_update). - Make your proposed changes to the documentation sources.
- Run your local version of the documentation server (e.g.
bench startin your bench installation). Make sure that your changes appear the way you want them to. - Commit your changes to your branch. Make sure to use a semantic commit message.
- Push your branch to your fork on Github, and issue a pull request.
MIT