Skip to content

Commit f6c80e5

Browse files
committed
Move guide docs under docs/guides and keep docs README at root
1 parent 3555de1 commit f6c80e5

5 files changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ FScript currently includes:
3636

3737
If you are new to FScript, start with the progressive tutorial:
3838

39-
- [`docs/getting-started-tutorial.md`](docs/getting-started-tutorial.md)
39+
- [`docs/guides/getting-started-tutorial.md`](docs/guides/getting-started-tutorial.md)
4040

4141
It covers installation, syntax basics, flow control, collections, pattern matching, stdlib usage, includes, and host/export concepts.
4242

@@ -129,10 +129,10 @@ See [`docs/specs/sandbox-and-security.md`](docs/specs/sandbox-and-security.md) f
129129
## Documentation
130130

131131
- Documentation portal: [`docs/README.md`](docs/README.md)
132-
- Tutorial: [`docs/getting-started-tutorial.md`](docs/getting-started-tutorial.md)
132+
- Tutorial: [`docs/guides/getting-started-tutorial.md`](docs/guides/getting-started-tutorial.md)
133133
- Specifications index: [`docs/specs/README.md`](docs/specs/README.md)
134134
- Architecture index: [`docs/architecture/README.md`](docs/architecture/README.md)
135-
- FScript vs F# / OCaml: [`docs/fsharp-ocaml-differences.md`](docs/fsharp-ocaml-differences.md)
135+
- FScript vs F# / OCaml: [`docs/guides/fsharp-ocaml-differences.md`](docs/guides/fsharp-ocaml-differences.md)
136136

137137
## Changelog
138138

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
This folder is organized into three layers:
44

5-
- Getting started and comparative docs (this folder)
5+
- Getting started and comparative docs (`docs/guides/`)
66
- Language behavior specifications: [`docs/specs/`](./specs/README.md)
77
- Internal structure and component design: [`docs/architecture/`](./architecture/README.md)
88

99
## Start here
1010

11-
- Tutorial: [`getting-started-tutorial.md`](./getting-started-tutorial.md)
12-
- FScript vs F# / OCaml: [`fsharp-ocaml-differences.md`](./fsharp-ocaml-differences.md)
13-
- Language rationale: [`language-choices.md`](./language-choices.md)
11+
- Tutorial: [`guides/getting-started-tutorial.md`](./guides/getting-started-tutorial.md)
12+
- FScript vs F# / OCaml: [`guides/fsharp-ocaml-differences.md`](./guides/fsharp-ocaml-differences.md)
13+
- Language rationale: [`guides/language-choices.md`](./guides/language-choices.md)
1414

1515
## Deep dives
1616

File renamed without changes.
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ let hasA = m |> Map.containsKey "a"
322322
```
323323

324324
Full reference:
325-
- [`docs/specs/stdlib-functions.md`](./specs/stdlib-functions.md)
325+
- [`docs/specs/stdlib-functions.md`](../specs/stdlib-functions.md)
326326

327327
## 10. Includes and modules
328328
You can split scripts using `#include`.
@@ -372,16 +372,16 @@ When embedding, keep this mindset:
372372
- expose only needed externs,
373373
- keep filesystem/network boundaries explicit,
374374
- use host-level timeout/cancellation/resource limits.
375-
- see [`docs/specs/embedding-fscript-language.md`](./specs/embedding-fscript-language.md) for the embedding API,
376-
- see [`docs/specs/external-functions.md`](./specs/external-functions.md) for extern design/registration,
377-
- see [`docs/specs/sandbox-and-security.md`](./specs/sandbox-and-security.md) for the full security model.
375+
- see [`docs/specs/embedding-fscript-language.md`](../specs/embedding-fscript-language.md) for the embedding API,
376+
- see [`docs/specs/external-functions.md`](../specs/external-functions.md) for extern design/registration,
377+
- see [`docs/specs/sandbox-and-security.md`](../specs/sandbox-and-security.md) for the full security model.
378378

379379
## 12. Next steps
380380
- Sample scripts:
381-
- [`samples/types-showcase.fss`](../samples/types-showcase.fss)
382-
- [`samples/patterns-and-collections.fss`](../samples/patterns-and-collections.fss)
383-
- [`samples/map-matching.fss`](../samples/map-matching.fss)
384-
- [`samples/includes-and-exports.fss`](../samples/includes-and-exports.fss)
385-
- Specifications index: [`docs/specs/README.md`](./specs/README.md)
386-
- Architecture index: [`docs/architecture/README.md`](./architecture/README.md)
387-
- [`samples/`](../samples/)
381+
- [`samples/types-showcase.fss`](../../samples/types-showcase.fss)
382+
- [`samples/patterns-and-collections.fss`](../../samples/patterns-and-collections.fss)
383+
- [`samples/map-matching.fss`](../../samples/map-matching.fss)
384+
- [`samples/includes-and-exports.fss`](../../samples/includes-and-exports.fss)
385+
- Specifications index: [`docs/specs/README.md`](../specs/README.md)
386+
- Architecture index: [`docs/architecture/README.md`](../architecture/README.md)
387+
- [`samples/`](../../samples/)
File renamed without changes.

0 commit comments

Comments
 (0)