Skip to content

Commit 64bac6c

Browse files
Enhance index.md with engaging and detailed documentation overview
- Improved the introduction and table of contents - Provided clear descriptions of EMScribe features - Updated directory structure for clarity - Included getting started steps for new users - Improved overall readability and user engagement
1 parent ec7100a commit 64bac6c

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/index.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Welcome to the EMScribe documentation! Here you'll find everything you need to k
1212
- [Installation](installation.md)
1313
- [Usage](usage.md)
1414
- [Development](development.md)
15-
- [API Reference](api_reference.md)
15+
- [API Reference](api_reference/index.md)
1616
- [Contributing](contributing.md)
1717
- [Contact](#contact)
1818

@@ -59,7 +59,14 @@ Here's a peek into how EMScribe is organized:
5959
| |-- narrative.txt
6060
| `-- reviewed_extract.txt
6161
|-- docs
62-
| |-- api_reference.md
62+
| |-- api_reference
63+
| | |-- extract_reviewer.md
64+
| | |-- index.md
65+
| | |-- model_loader.md
66+
| | |-- narrative_manager.md
67+
| | |-- prompt_manager.md
68+
| | |-- transcript_cleaner.md
69+
| | `-- transcript_extractor.md
6370
| |-- contributing.md
6471
| |-- development.md
6572
| |-- index.md
@@ -82,12 +89,6 @@ Here's a peek into how EMScribe is organized:
8289
|-- requirements.txt
8390
|-- scripts
8491
| |-- cli.py
85-
| |-- data
86-
| | |-- cleaned_transcript.txt
87-
| | `-- extract.txt
88-
| |-- extraction.py
89-
| |-- main.py
90-
| `-- preprocess.py
9192
|-- tests
9293
| |-- conftest.py
9394
| |-- test_cli.py
@@ -106,7 +107,7 @@ Ready to jump in? Here’s how to get started with EMScribe:
106107
1. **[Installation Instructions](installation.md)**: Set up EMScribe on your machine.
107108
2. **[Usage Guide](usage.md)**: Learn how to run scripts and make the most out of EMScribe.
108109
3. **[Development Guide](development.md)**: For developers looking to contribute, this guide covers everything you need to know.
109-
4. **[API Reference](api_reference.md)**: Detailed information about the API and how to use each module.
110+
4. **[API Reference](api_reference/index.md)**: Detailed information about the API and how to use each module.
110111
5. **[Contributing Guidelines](contributing.md)**: Learn how to contribute to the project.
111112

112113
## 📧 Contact

0 commit comments

Comments
 (0)