Skip to content

Commit ac5850c

Browse files
authored
Merge branch 'main' into mossaka/benchmark
Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
2 parents a11aa2b + beda918 commit ac5850c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+16309
-2325
lines changed

.dockerignore

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Git files
2+
.git
3+
.gitignore
4+
.gitattributes
5+
6+
# GitHub workflows and documentation
7+
.github
8+
docs/book
9+
docs/TODO.md
10+
11+
# Target and build artifacts
12+
target/**
13+
!target/release/wassette
14+
bin
15+
*.wasm
16+
17+
# Examples and tests
18+
examples/*/target
19+
tests
20+
21+
# Documentation
22+
*.md
23+
!README.md
24+
LICENSE
25+
NOTICE
26+
SECURITY.md
27+
CODE_OF_CONDUCT.md
28+
CONTRIBUTING.md
29+
30+
# Development files
31+
.vscode
32+
.idea
33+
*.swp
34+
*.swo
35+
*~
36+
37+
# Rust artifacts
38+
**/*.rs.bk
39+
Cargo.lock.bak
40+
41+
# OS files
42+
.DS_Store
43+
Thumbs.db
44+
45+
# CI/Docker files
46+
Dockerfile.ci
47+
docker-compose.yml
48+
49+
# Scripts
50+
scripts
51+
52+
# Package manager files
53+
Formula
54+
flake.nix
55+
flake.lock
56+
winget
57+
58+
# Other
59+
assets
60+
audit.toml
61+
deny.toml
62+
_typos.toml
63+
rustfmt.toml
64+
component-registry.json
65+
policy.yaml
66+
install.sh

.github/instructions/docs.instructions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ applyTo: "docs/**/*.md"
66

77
When working on documentation changes that affect visual presentation or layout, **always use Playwright** to display and capture visual changes. This helps reviewers understand the impact of documentation modifications.
88

9+
## Writing Style Guidelines
10+
11+
**Keep documentation concise and code-focused:**
12+
- Prefer code examples over verbose explanations
13+
- Keep document files focused and concise for readability
14+
- Use clear, simple language that's easy to understand
15+
- Show working examples first, explain details second
16+
- Remove unnecessary words - every sentence should add value
17+
- Write the answer as 2–4 cohesive paragraphs. No bullet points, no numbered lists, no sub-headings, no tables, no Markdown lists.
18+
919
## Running the Documentation Locally
1020

1121
The project uses [mdbook](https://rust-lang.github.io/mdBook/) for documentation. Use the following commands:

.github/instructions/rust.instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ View the design/architecture.md for a high-level overview of the architecture an
2222
- Use traits to define shared behavior and generics to create reusable, type-safe components. Design the API to be extensible
2323
- Use stdlib primitives like `Arc` and `Mutex` for thread safety and shared state.
2424
- Choose appropriate data types like `&str` over `String` for performance and memory efficiency.
25+
- ALWAYS run `cargo machete` at the end to check for unused dependencies.
2526

2627
## Copyright Headers
2728

0 commit comments

Comments
 (0)