Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,19 @@ For more information on how to use Docusaurus, see the
3. Install the dependencies: `pnpm install`
4. Run the development server: `pnpm dev`, which will start a local server and open a browser window.
All changes you make to the markdown files will be reflected live in the browser.

### Adding new pages

All of our directory and file names are prefixed with a five-digit number which determines how they're sorted.
We started with the hundreds place as the smallest significant digit, to allow using the tens and ones places to add new pages between.
When adding a new page in between two existing pages, choose a number which:

- Doesn't use any more significant figures than it needs to.
- Is approximately halfway between the previous and next page.

For example, if you want to add a new page between `00300-foo` and `00400-bar`, name it `00350-baz`. To add a new page between `00350-baz` and `00400-bar`, prefer `00370-quux` or `00380-quux`, rather than `00375-quux`, to avoid populating the ones place.

To add a new page after all previous pages, use the smallest multiple of 100 larger than all other pages. For example, if the highest-numbered existing page is `01350-abc`, create `01400-def`.

## License

Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions smoketests/tests/quickstart.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,8 @@ def _test_quickstart(self):

class Rust(BaseQuickstart):
lang = "rust"
server_doc = STDB_DIR / "docs/docs/02-quickstarts/03-rust.md"
client_doc = STDB_DIR / "docs/docs/02-quickstarts/03-rust.md"
server_doc = STDB_DIR / "docs/docs/00200-quickstarts/00300-rust.md"
client_doc = STDB_DIR / "docs/docs/00200-quickstarts/00300-rust.md"
server_file = "src/lib.rs"
client_file = "src/main.rs"
module_bindings = "src/module_bindings"
Expand Down Expand Up @@ -249,8 +249,8 @@ def test_quickstart(self):

class CSharp(BaseQuickstart):
lang = "csharp"
server_doc = STDB_DIR / "docs/docs/02-quickstarts/02-c-sharp.md"
client_doc = STDB_DIR / "docs/docs/02-quickstarts/02-c-sharp.md"
server_doc = STDB_DIR / "docs/docs/00200-quickstarts/00200-c-sharp.md"
client_doc = STDB_DIR / "docs/docs/00200-quickstarts/00200-c-sharp.md"
server_file = "Lib.cs"
client_file = "Program.cs"
module_bindings = "module_bindings"
Expand Down Expand Up @@ -362,7 +362,7 @@ def test_quickstart(self):
class TypeScript(Rust):
lang = "typescript"
client_lang = "rust"
server_doc = STDB_DIR / "docs/docs/02-quickstarts/01-typescript.md"
server_doc = STDB_DIR / "docs/docs/00200-quickstarts/00100-typescript.md"
server_file = "src/index.ts"

def server_postprocess(self, server_path: Path):
Expand Down
Loading