Skip to content

About

Documentation for Devvit, Reddit's Developer Platform

Resources

Code of conduct

Security policy

Stars

15 stars

Watchers

1 watching

Forks

Repository files navigation

Devvit Docs

Devvit Docs

Documentation for Reddit's Developer Platform

Create a Devvit App Read the docs

Contribution

These docs are intended to be public, and contributions are always welcome. Please raise a PR and we'll approve regularly!

Contribution License Agreement

The first time you submit a pull request (PR) to a Reddit project, you should complete our CLA. We cannot accept PRs from GitHub users that have not agreed to the CLA. Note that this agreement applies to all open source Reddit projects, and you only need to submit it once.

Submit your CLA here.

Make sure to update both versioned and unversioned docs

All changes made to the Devvit docs but be made to both the latest versioned instance of the docs as well as the unversioned instance of those docs. While we know this isn't ideal, it is essential for ensuring changes aren't overwritten as new versions of Devvit are released.

Development

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Share the Devvit AI Helper

Use https://developers.reddit.com/docs/?ask=1 to open the Kapa widget directly. Visitors can also open the helper with the Ask AI widget in the bottom-right corner of any docs page.

To prefill a question, add a URL-encoded question parameter, for example:

https://developers.reddit.com/docs/?ask=1&question=How%20do%20I%20get%20started%3F

The question is prefilled for the visitor to review and submit. The ask=1 parameter also works on individual documentation pages, allowing a shared link to keep that page as context. Kapa's knowledge sources are configured separately in the Kapa platform.

About

Documentation for Devvit, Reddit's Developer Platform

Resources

Code of conduct

Security policy

Stars

15 stars

Watchers

1 watching

Forks

Used by

Contributors

Languages