https://github.com/server-state/docs

Documentation for the Server State project
https://github.com/server-state/docs

docs server server-state state

Last synced: 3 months ago
JSON representation

Documentation for the Server State project

• Host: GitHub
• URL: https://github.com/server-state/docs
• Owner: server-state
• License: mit
• Created: 2020-07-25T11:07:22.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2026-01-11T05:54:07.000Z (5 months ago)
• Last Synced: 2026-01-11T12:46:07.929Z (5 months ago)
• Topics: docs, server, server-state, state
• Language: MDX
• Homepage: https://www.server-state.tech?ref=github--server-state--docs
• Size: 4.8 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Server State Docs

[![CI](https://github.com/server-state/docs/actions/workflows/ci.yml/badge.svg)](https://github.com/server-state/docs/actions/workflows/ci.yml)

[![Build and Deploy](https://github.com/server-state/docs/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/server-state/docs/actions/workflows/gh-pages.yml)

[![Prettier Auto Fix on main](https://github.com/server-state/docs/actions/workflows/prettier-auto-fix.yml/badge.svg)](https://github.com/server-state/docs/actions/workflows/prettier-auto-fix.yml)

[![GitHub](https://img.shields.io/github/license/server-state/docs)](LICENSE)

[![Twitter Follow](https://img.shields.io/twitter/follow/server_state?style=social)](https://twitter.com/server_state)

[![Banner with Server State logo](static/img/banners/banner-1.jpg)](https://www.server-state.tech)

This repository contains the documentation for Server State. It is available at

https://www.server-state.tech.

_Please note that this **does not** contain technical references for all Server

State components. For that, please refer to the individual READMEs and other

resources of the individual modules. Instead, this documentation focuses on more

general documentation of Server State and how to extend it._

## Writer's guide

You can find a guide for writers/contributors to the documentation at

`src/pages/writers-guide.mdx`, or, within the built website, at

`/writers-guide`.

Please familiarize yourself with these guidelines _before_ beginning to write

documentation for the project.

## Templates

The `_templates` folder has a few templates for the most common types of pages

you need to write to document the project.

These also include tips and tricks (as comments) as well as valuable snippets

relevant to this specific type of page (e.g., tutorial)

If you feel like any basic templates are lacking, please search through

[this repository's issues](https://github.com/server-state/docs/issues) for a

reference to this type of template. If you don't find any reference to it,

please feel free to open an issue for it yourself.