mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-12 02:37:53 -04:00
Tyler Cloutier
d78517fd9a
# Description of Changes This PR does several small things: 1. It removes the explicit `h1` tags on every page, and either uses the side bar title directly, or puts it in the frontmatter 2. It merges what are currently called quickstarts into a single Chat App Tutorial 3. It creates new quickstarts which just use `spacetime dev --template` to get you up and running quickly 4. It adds a "The Zen of SpacetimeDB" page much like the Zen of Python which goes over the 5 key principles of SpacetimeDB 5. It reorders all Tabs groups so that the ordering is `TypeScript`, `C#`, `Rust`, `Unreal`, `C++`, `Blueprints` (order of decreasing popularity). 6. It improves the sidebar navigation by having categories act as overview pages, and also fixes the breadcrumbs 7. It fixes various small typos and issues 8. Closes #3610 and adds cursor rules files generally 9. It fixes general styling on the docs page by bring it inline with the UI design: Old: <img width="1678" height="958" alt="image" src="https://github.com/user-attachments/assets/f36efee6-b81a-4463-a179-da68b3a7152e" /> New: <img width="1678" height="957" alt="image" src="https://github.com/user-attachments/assets/f430f77d-0663-47f2-9727-45cbfe10e4c7" /> https://github.com/user-attachments/assets/adc5a78a-ada8-45b5-8078-a45cb81477a3 # API and ABI breaking changes This PR does NOT change any old links. It does add new pages though. # Expected complexity level and risk 3 - it's a large change. I manually tested the TypeScript Chat App Tutorial but I have not gone through the Rust and C# quickstarts. However, we have testing on the quickstarts and this is text only so can be carefully reviewed. # Testing <!-- Describe any testing you've done, and any testing you'd like your reviewers to do, so that you're confident that all the changes work as expected! --> - [x] Ran through each step of the Chat App TypeScript tutorial to ensure it is working - [x] Ran and tested the styles and the functionality of the side bar --------- Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Co-authored-by: spacetimedb-bot <spacetimedb-bot@users.noreply.github.com> Co-authored-by: clockworklabs-bot <clockworklabs-bot@users.noreply.github.com> Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com> Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
238 lines
3.7 KiB
Plaintext
238 lines
3.7 KiB
Plaintext
|
|
# Created by https://www.toptal.com/developers/gitignore/api/rust,node,visualstudiocode
|
|
# Edit at https://www.toptal.com/developers/gitignore?templates=rust,node,visualstudiocode
|
|
|
|
flamegraphs/*.svg
|
|
flamegraphs/flamegraph.folded
|
|
|
|
### MacOS ###
|
|
.DS_Store
|
|
|
|
### Node ###
|
|
# Logs
|
|
packages/logs
|
|
*.log
|
|
npm-debug.log*
|
|
yarn-debug.log*
|
|
yarn-error.log*
|
|
lerna-debug.log*
|
|
.pnpm-debug.log*
|
|
|
|
# Diagnostic reports (https://nodejs.org/api/report.html)
|
|
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
|
|
|
# Runtime data
|
|
pids
|
|
*.pid
|
|
*.seed
|
|
*.pid.lock
|
|
|
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
|
lib-cov
|
|
|
|
# Coverage directory used by tools like istanbul
|
|
coverage
|
|
*.lcov
|
|
|
|
# nyc test coverage
|
|
.nyc_output
|
|
|
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
|
.grunt
|
|
|
|
# Bower dependency directory (https://bower.io/)
|
|
bower_components
|
|
|
|
# node-waf configuration
|
|
.lock-wscript
|
|
|
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
|
build/Release
|
|
|
|
# Dependency directories
|
|
node_modules
|
|
jspm_packages
|
|
|
|
# Snowpack dependency directory (https://snowpack.dev/)
|
|
web_modules
|
|
|
|
# TypeScript cache
|
|
*.tsbuildinfo
|
|
|
|
# Optional npm cache directory
|
|
.npm
|
|
|
|
# Optional eslint cache
|
|
.eslintcache
|
|
|
|
# Optional stylelint cache
|
|
.stylelintcache
|
|
|
|
# Microbundle cache
|
|
.rpt2_cache/
|
|
.rts2_cache_cjs/
|
|
.rts2_cache_es/
|
|
.rts2_cache_umd/
|
|
|
|
# Optional REPL history
|
|
.node_repl_history
|
|
|
|
# Output of 'npm pack'
|
|
*.tgz
|
|
|
|
# Yarn Integrity file
|
|
.yarn-integrity
|
|
|
|
# dotenv environment variable files
|
|
.env
|
|
.env.development.local
|
|
.env.test.local
|
|
.env.production.local
|
|
.env.local
|
|
|
|
# parcel-bundler cache (https://parceljs.org/)
|
|
.cache
|
|
.parcel-cache
|
|
|
|
# Next.js build output
|
|
.next
|
|
out
|
|
|
|
# Nuxt.js build / generate output
|
|
.nuxt
|
|
dist
|
|
|
|
# Gatsby files
|
|
.cache/
|
|
# Comment in the public line in if your project uses Gatsby and not Next.js
|
|
# https://nextjs.org/blog/next-9-1#public-directory-support
|
|
# public
|
|
|
|
# vuepress build output
|
|
.vuepress/dist
|
|
|
|
# vuepress v2.x temp and cache directory
|
|
.temp
|
|
|
|
# Docusaurus cache and generated files
|
|
.docusaurus
|
|
|
|
# Serverless directories
|
|
.serverless/
|
|
|
|
# FuseBox cache
|
|
.fusebox/
|
|
|
|
# DynamoDB Local files
|
|
.dynamodb/
|
|
|
|
# TernJS port file
|
|
.tern-port
|
|
|
|
# Stores VSCode versions used for testing VSCode extensions
|
|
.vscode-test
|
|
|
|
# yarn v2
|
|
.yarn/cache
|
|
.yarn/unplugged
|
|
.yarn/build-state.yml
|
|
.yarn/install-state.gz
|
|
.pnp.*
|
|
|
|
### Node Patch ###
|
|
# Serverless Webpack directories
|
|
.webpack/
|
|
|
|
# Optional stylelint cache
|
|
|
|
# SvelteKit build / generate output
|
|
.svelte-kit
|
|
|
|
### Rust ###
|
|
# Generated by Cargo
|
|
# will have compiled files and executables
|
|
debug/
|
|
target/
|
|
# for docker images touching host fs
|
|
linux-cache/
|
|
linux-rustup/
|
|
linux-target/
|
|
|
|
# These are backup files generated by rustfmt
|
|
**/*.rs.bk
|
|
|
|
# MSVC Windows builds of rustc generate these, which store debugging information
|
|
*.pdb
|
|
|
|
### VisualStudioCode ###
|
|
.vscode/*
|
|
.vscode
|
|
!.vscode/settings.json
|
|
!.vscode/tasks.json
|
|
!.vscode/launch.json
|
|
!.vscode/extensions.json
|
|
!.vscode/*.code-snippets
|
|
|
|
# Local History for Visual Studio Code
|
|
.history/
|
|
|
|
# Built Visual Studio Code Extensions
|
|
*.vsix
|
|
|
|
### VisualStudioCode Patch ###
|
|
# Ignore all local history of files
|
|
.history
|
|
.ionide
|
|
|
|
# Support for Project snippet scope
|
|
|
|
# End of https://www.toptal.com/developers/gitignore/api/rust,node,visualstudiocode
|
|
|
|
|
|
# Added by cargo
|
|
#
|
|
# already existing elements were commented out
|
|
|
|
/target
|
|
#Cargo.lock
|
|
|
|
__pycache__/
|
|
.test_out
|
|
|
|
## JetBrains
|
|
.idea/
|
|
|
|
/protobuf
|
|
cs-src/
|
|
crates/bench/spacetime.svg
|
|
crates/bench/sqlite.svg
|
|
.vs/
|
|
|
|
# benchmark files
|
|
out.json
|
|
old.json
|
|
new.json
|
|
.history.txt
|
|
|
|
# Keys
|
|
*.pem
|
|
.ok.sql
|
|
|
|
# Test data
|
|
!crates/core/testdata/
|
|
|
|
# Temporary templates dir for CLI's init command
|
|
/crates/cli/.templates
|
|
|
|
# Symlinked output from `nix build`
|
|
result
|
|
|
|
# Python venv directories
|
|
venv/
|
|
|
|
# Claude Code
|
|
.claude/
|
|
|
|
# Windows null device artifact
|
|
nul
|