krypticmouse/dspy-docs

Official Documentation for DSPy Library

DSPy Documentation

This website is built using Docusaurus, a modern static website generator.

Contributing to the docs Folder

This guide is for contributors looking to make changes to the documentation in the dspy/docs folder.

1. Pull the up-to-date version of the website: Please pull the latest version of the live documentation site via its subtree repository with the following command:

#Ensure you are in the top-level dspy/ folder
git subtree pull --prefix=docs https://github.com/krypticmouse/dspy-docs master

2. Push your new changes on a new branch: Feel free to add or edit existing documentation and open a PR for your changes. Once your PR is reviewed and approved, the changes will be ready to merge into main.

3. Updating the website: Once your changes are merged to main, they need to be pushed to the subtree repository that hosts the live documentation site. This step will eventually be done automatically, but for now, please run the following command to push the updated docs content to the website subtree repository:

#Ensure you are in the top-level dspy/ folder
git subtree push --prefix=docs https://github.com/krypticmouse/dspy-docs master

dspy-docs's Issues

Make a community content page

We should have a page dedicated to content made by the DSPy community. This would provide easy and plentiful distribution of DSPy content and backlinks to this official documents hub.

By doing this we will have some incentive alignment for community members to write, record, and speak more about DSPy. This in turn will help both grow the community and enrich it as each member provides more value to it through indirect contribution.

Some examples of content that has be created and should be added to this page once created is below.

Acceptance Criteria:

• The new page is visible to the public on the docs website
• A comprehensive list of public DSPy content is on the page
• Some contributing guidance is given on the page (ie. No twitter links, additions need to be reviewed, etc)