Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thephez committed Oct 19, 2023
1 parent 684a18b commit 3d8b948
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# docs-platform
# Dash Platform Docs

[![Build
status](https://img.shields.io/readthedocs/dash-docs-platform/stable)](https://readthedocs.org/projects/dash-docs-platform/builds/)
[![standard-readme
compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen)](https://github.com/RichardLitt/standard-readme)

Dash Platform Documentation

Welcome to the Dash Platform developer documentation. You’ll find sections for reference
information, API details, tutorials, and library information to help you start working with Dash as
quickly as possible. This Platform developer documentation is available at
https://docs.dash.org/projects/platform, while user documentation is maintained at
https://docs.dash.org/ and Core developer documentation at https://docs.dash.org/projects/core.

## Contributing

This documentation is written in primarily in [markdown](https://www.markdownguide.org/) and uses
the [myst-parser extension](https://myst-parser.readthedocs.io/en/latest/index.html) for
compatibility with [reStructuredText](https://docutils.sourceforge.io/rst.html). It is designed to
be built with [Sphinx](https://www.sphinx-doc.org/) and hosted by [Read the
Docs](https://readthedocs.org/). Feel free to [open an
issue](https://github.com/dashpay/docs-platform/issues/new/choose) or submit PRs modifying the
English source text in this repository.

## License

[MIT](/LICENSE) © Dash Core Group, Inc.

0 comments on commit 3d8b948

Please sign in to comment.