Tyler Cloutier
48bab90a41
* Added a script to check the validity of docs links and a .github action * Removed erroneous thing * Switched the action trigger * Added workflow to ensure that the nav.ts has been built to nav.js * typo * Build nav.ts * typo thing * Fixed script issue * Fix * Fixed a few links * Added relative link resolution and fixed the broken links * now checking fragments * Now checking fragments properly and publishing some stats * Forgot exit code * Fix broken links Well, in at least some cases, just remove broken links. - The BSATN ref contained links to type defns, but didn't have type defns. Replace the links with plain text. - HTTP database links for recovery-code related routes were getting mangled in some way I couldn't figure out, so the links weren't working despite their targets clearly existing. Conveniently, those routes have been removed, so remove the links and the corresponding sections. - The JSON doc (erroneously called "SATN") contained typos, spelling "producttype" as "productype". - C# SDK ref had links to a section on the `Address` type, but no such section. Replace the links with plain text. - Rust SDK ref had a link getting mangled in a way I couldn't figure out. Simplify the section title so that the anchor name is predictable. - TypeSciprt SDK ref used camelCase names in anchor links, but we downcase all section titles to create anchor names. Also slap a section in README.md which says how to run the checker locally. --------- Co-authored-by: Phoebe Goldman <phoebe@goldman-tribe.org>
1.5 KiB
SpacetimeDB Documentation
This repository contains the markdown files which are used to display documentation on our website.
Making Edits
To make changes to our docs, you can open a pull request in this repository. You can typically edit the files directly using the GitHub web interface, but you can also clone our repository and make your edits locally. To do this you can follow these instructions:
- Fork our repository
- Clone your fork:
git clone ssh://git@github.com/<username>/spacetime-docs
- Make your edits to the docs that you want to make + test them locally
- Commit your changes:
git add .
git commit -m "A specific description of the changes I made and why"
- Push your changes to your fork as a branch
git checkout -b a-branch-name-that-describes-my-change
git push -u origin a-branch-name-that-describes-my-change
- Go to our GitHub and open a PR that references your branch in your fork on your GitHub
NOTE! If you make a change to
nav.tsyou will have to runnpm run buildto generate a newdocs/nav.jsfile.
Checking Links
We have a CI job which validates internal links. You can run it locally with npm run check-links. This will print any internal links (i.e. links to other docs pages) whose targets do not exist, including fragment links (i.e. #-ey links to anchors).
License
This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details.