Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesHome
You have left the Sefaria Website and are now viewing the Sefaria Wiki which is hosted on GitHub. Back to Sefaria »
Frequently Asked Questions
Educators
Webmasters / Bloggers
Contributing Textually
- Understanding Sefaria's Structure
- Guide to Contributing
- How to Report a Mistake
- Adding Non-English Translations
- Current Textual Projects
- Workflowy Text Outline Tool
Technical Documentation
- API Documentation
- Text References
- The Structure of a Book in Sefaria
- Index Records for Simple and Complex Texts
- Commentaries in Sefaria
- Categories as first class objects
- The Command Line Interface
- Source Sheets Document Format
- Python Code Documentation on Read the Docs
- Sefaria.js
- Projects for Volunteer Developers
- GitHub Issues for Sefaria-Project
- Getting Started as a Sefaria Developer - guide for new Content Engineers
Tools & Tech
- Regular Expression Engines
- Workflowy Text Outline Tool
- Datamining Mesorat HaShas
- Commentary Matcher (aka Dibur Hamatchil Matcher)
Sefaria Coding Practice
Development Plans
- GitHub Issues - user reported bugs and feature requests plus small projects that are appropriate for new contributors.
- Draft Spec: Gardens