mirror of
https://github.com/HeyPuter/puter.git
synced 2026-01-05 20:50:22 -06:00
46 lines
1.5 KiB
Markdown
46 lines
1.5 KiB
Markdown
# Puter Documentation
|
|
|
|
Hi, you've found Puter's wiki page on GitHub! If you were looking for
|
|
something else, you might find it in the links below.
|
|
All of the wiki docs are generated from `doc/` directories in the main
|
|
repository, so it's best to edit docs there rather than here.
|
|
|
|
## Users
|
|
|
|
If you have general questions about using [Puter](https://puter.com),
|
|
our [community Discord](https://discord.gg/PQcx7Teh8u) and
|
|
[subreddit](https://www.reddit.com/r/puter/) are good places
|
|
to ask questions.
|
|
|
|
## Deployers
|
|
|
|
- [Hosting Instructions](./self-hosters/instructions.md)
|
|
- [Configuration](./self-hosters/config.md)
|
|
- [Domain Setup](./self-hosters/domains.md)
|
|
- [Support Levels](./self-hosters/support.md)
|
|
|
|
## App Developer Links
|
|
- [developer.puter.com](https://developer.puter.com)
|
|
- [docs.puter.com](https://docs.puter.com)
|
|
- share your apps on [Reddit](https://www.reddit.com/r/puter/) or
|
|
[Discord](https://discord.gg/PQcx7Teh8u)
|
|
|
|
## Contributor Documentation
|
|
|
|
### Where to Start
|
|
|
|
Start with [Repo Structure and Tooling](./contributors/structure.md).
|
|
|
|
### Index
|
|
|
|
- **Conventions**
|
|
- [Repo Structure and Tooling](./contributors/structure.md)
|
|
- How directories and files are organized in our GitHub repo
|
|
- What tools are used to build parts of Puter
|
|
- [Comment Prefixes](./contributors/comment_prefixes.md)
|
|
- A convention we use for line comments in code
|
|
|
|
- [Frontend Documentation](/src/gui/doc)
|
|
- [Backend Documentation](/src/backend/doc)
|
|
- [Extensions](./contributors/extensions/)
|