Skip to content

Commit 2de7e1c

Browse files
fix: update README links to use strawgate.com and fix markdown lint errors
- Changed all documentation links from strawgate.github.io to strawgate.com - Updated project links section to point to docs instead of subdirectory READMEs - Removed invalid link fragments from docs/wrappers.md table - Fixed duplicate heading in docs/wrappers.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: William Easton <[email protected]>
1 parent 7063aa2 commit 2de7e1c

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ This monorepo contains two libraries:
88

99
## Documentation
1010

11-
- [Full Documentation](https://strawgate.github.io/py-key-value/)
12-
- [Getting Started Guide](https://strawgate.github.io/py-key-value/getting-started/)
13-
- [Wrappers Guide](https://strawgate.github.io/py-key-value/wrappers/)
14-
- [Adapters Guide](https://strawgate.github.io/py-key-value/adapters/)
15-
- [API Reference](https://strawgate.github.io/py-key-value/api/protocols/)
11+
- [Full Documentation](https://strawgate.com/py-key-value/)
12+
- [Getting Started Guide](https://strawgate.com/py-key-value/getting-started/)
13+
- [Wrappers Guide](https://strawgate.com/py-key-value/wrappers/)
14+
- [Adapters Guide](https://strawgate.com/py-key-value/adapters/)
15+
- [API Reference](https://strawgate.com/py-key-value/api/protocols/)
1616

1717
## Why use this library?
1818

@@ -196,7 +196,7 @@ Each store has a **stability rating** indicating likelihood of
196196
backwards-incompatible changes. Stable stores (Redis, Valkey, Disk, Keyring)
197197
are recommended for long-term storage.
198198

199-
**[📚 View all stores, installation guides, and examples →](https://strawgate.github.io/py-key-value/stores/)**
199+
**[📚 View all stores, installation guides, and examples →](https://strawgate.com/py-key-value/stores/)**
200200

201201
### Adapters
202202

@@ -209,7 +209,7 @@ use cases:
209209
- **RaiseOnMissingAdapter**: Raise exceptions instead of returning None for
210210
missing keys
211211

212-
**[📚 View all adapters with examples →](https://strawgate.github.io/py-key-value/adapters/)**
212+
**[📚 View all adapters with examples →](https://strawgate.com/py-key-value/adapters/)**
213213

214214
**Quick example** - PydanticAdapter for type-safe storage:
215215

@@ -263,7 +263,7 @@ wrappers include:
263263
- **Constraints**: LimitSize, TTLClamp, DefaultValue
264264
- **Observability**: Logging, Statistics
265265

266-
**[📚 View all wrappers with examples →](https://strawgate.github.io/py-key-value/wrappers/)**
266+
**[📚 View all wrappers with examples →](https://strawgate.com/py-key-value/wrappers/)**
267267

268268
Wrappers can be stacked for complex functionality:
269269

@@ -353,8 +353,8 @@ library.
353353

354354
## Project links
355355

356-
- Async README: `key-value/key-value-aio/README.md`
357-
- Sync README: `key-value/key-value-sync/README.md`
356+
- [Full Documentation](https://strawgate.com/py-key-value/)
357+
- [API Reference](https://strawgate.com/py-key-value/api/protocols/)
358358

359359
Contributions welcome but may not be accepted. File an issue before submitting
360360
a pull request. If you do not get agreement on your proposal before making a

docs/wrappers.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ protocol, so they can be used anywhere a store can be used.
88

99
| Wrapper | Description |
1010
|---------|-------------|
11-
| [CollectionRoutingWrapper](#collectionroutingwrapper) | Route operations to different stores based on collection name |
1211
| [CompressionWrapper](#compressionwrapper) | Compress values before storing and decompress on retrieval |
13-
| [DefaultValueWrapper](#defaultvaluewrapper) | Return a default value when key is missing |
1412
| [FernetEncryptionWrapper](#fernetencryptionwrapper) | Encrypt values before storing and decrypt on retrieval |
1513
| [FallbackWrapper](#fallbackwrapper) | Fallback to a secondary store when the primary store fails |
1614
| [LimitSizeWrapper](#limitsizewrapper) | Limit the size of entries stored in the cache |
@@ -20,11 +18,10 @@ protocol, so they can be used anywhere a store can be used.
2018
| [PrefixKeysWrapper](#prefixkeyswrapper) | Prefix all keys with a given prefix |
2119
| [ReadOnlyWrapper](#readonlywrapper) | Prevent all write operations on the underlying store |
2220
| [RetryWrapper](#retrywrapper) | Retry failed operations with exponential backoff |
23-
| [RoutingWrapper](#routingwrapper) | Route operations to different stores based on a routing function |
2421
| [SingleCollectionWrapper](#singlecollectionwrapper) | Wrap a store to only use a single collection |
22+
| [TTLClampWrapper](#ttlclampwrapper) | Clamp the TTL to a given range |
2523
| [StatisticsWrapper](#statisticswrapper) | Track operation statistics for the store |
2624
| [TimeoutWrapper](#timeoutwrapper) | Add timeout protection to store operations |
27-
| [TTLClampWrapper](#ttlclampwrapper) | Clamp the TTL to a given range |
2825

2926
## What Are Wrappers?
3027

@@ -54,7 +51,7 @@ Wrappers execute in the order they are stacked:
5451
- **Writes** (put, delete): Outer wrapper → Inner wrapper → Store
5552
- **Reads** (get, ttl): Store → Inner wrapper → Outer wrapper
5653

57-
## Available Wrappers
54+
## Wrapper Details
5855

5956
### CompressionWrapper
6057

0 commit comments

Comments
 (0)