Skip to content

Commit 8620934

Browse files
committed
make doc references links
1 parent cf9db52 commit 8620934

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Later layers override earlier ones. Use envstack -t VAR to trace where a value
2727
comes from. envstack focuses on **configuration and activation**, not dependency
2828
resolution.
2929

30-
For the core concepts, see `docs/index.md`.
30+
For the core concepts, see [docs/index.md](docs/index.md).
3131

3232
## Installation
3333

@@ -39,7 +39,7 @@ pip install -U envstack
3939

4040
## Quickstart
4141

42-
Start by getting the latest `default.env` example file:
42+
Start by getting the latest [default.env](examples/default/default.env) example file:
4343

4444
```bash
4545
curl -o \
@@ -130,13 +130,13 @@ committed, or distributed.
130130
Encryption protects values **at rest** and integrates with environment stacks and
131131
includes. envstack does not attempt to be a full secret management system.
132132
133-
See `docs/secrets.md` for details.
133+
See [docs/secrets.md](docs/secrets.md) for details.
134134
135135
## Documentation
136136
137-
- Design & philosophy`docs/design.md`
138-
- Examples & patterns`docs/examples.md`
139-
- Tool comparisons`docs/comparison.md`
140-
- Secrets and encryption`docs/secrets.md`
141-
- FAQ & gotchas`docs/faq.md`
142-
- API docs`docs/api.md`
137+
- [Design & philosophy](docs/design.md)
138+
- [Examples & patterns](docs/examples.md)
139+
- [Tool comparisons](docs/comparison.md)
140+
- [Secrets and encryption](docs/secrets.md)
141+
- [FAQ & gotchas](docs/faq.md)
142+
- [API docs](docs/api.md)

docs/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ flowchart LR
4545
```
4646

4747
Typical characteristics:
48-
- A base environment defines common paths and defaults
48+
- A default base environment defines common paths and defaults
4949
- Environment tiers override a small number of variables
5050
- The active environment is explicit
5151

0 commit comments

Comments
 (0)