Skip to content

Commit 66f5687

Browse files
committed
Rearranges documentation sections for clarity.
Reorganizes the README to improve readability by grouping related documentation sections together, specifically moving the full API documentation and AI usage sections to be adjacent to their corresponding references.
1 parent 70313a6 commit 66f5687

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ With nicer IndexOutOfRangeExceptions that include the bad index and the actual s
2020

2121
- Extensive Tests running on both .NET and JS
2222

23+
24+
### Full API Documentation
25+
26+
[goswinr.github.io/Str](https://goswinr.github.io/Str/reference/str.html)
27+
28+
### Use of AI and LLMs in the project
29+
All core function are are written by hand to ensure performance and correctness.<br>
30+
However, AI tools have been used for code review, typo and grammar checking in documentation<br>
31+
and to generate not all but many of the tests.
32+
33+
2334
### Usage
2435
Just open the module
2536

@@ -282,15 +293,6 @@ sb.Contains "hello" // true
282293
sb.IndexOf "," // 5
283294
```
284295

285-
### Full API Documentation
286-
287-
[goswinr.github.io/Str](https://goswinr.github.io/Str/reference/str.html)
288-
289-
### Use of AI and LLMs
290-
All core function are are written by hand to ensure performance and correctness.<br>
291-
However, AI tools have been used for code review, typo and grammar checking in documentation<br>
292-
and to generate not all but many of the tests.
293-
294296
### Tests
295297
All Tests run in both javascript and dotnet.
296298
Successful Fable compilation to typescript is verified too.

0 commit comments

Comments
 (0)