Skip to content

Commit e12b790

Browse files
authored
Merge pull request #137 from rmusser01/dev
Dev
2 parents 22f541b + 4aae9ae commit e12b790

File tree

2 files changed

+56
-5
lines changed

2 files changed

+56
-5
lines changed

Docs/Documentation.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,66 @@
11
# tldw Documentation
22

3-
3+
------------------------------------------------------------------------------------------------------------------------
44
## Table of Contents
55
- [Introduction](#introduction)
66
- [Installation](#installation)
77
- [Usage](#usage)
88
- [Commands](#commands)
9-
- [Pieces](#pieces)
9+
- [Pieces](./pieces/Piece.md)
10+
- This is a link to the Pieces documentation.
11+
- The pieces document contains the documentation for the code flow and processing pipelines of the main function.
1012
- [Contributing](#contributing)
1113
- [License](#license)
1214
- [Contact](#contact)
1315
- [Acknowledgements](#acknowledgements)
14-
- [FAQ](#faq)
16+
- [FAQ](#faq)
17+
------------------------------------------------------------------------------------------------------------------------
18+
19+
20+
------------------------------------------------------------------------------------------------------------------------
21+
### <a name="introduction"></a>Introduction
22+
-
23+
24+
------------------------------------------------------------------------------------------------------------------------
25+
26+
------------------------------------------------------------------------------------------------------------------------
27+
### <a name="installation"></a> Installation
28+
-
29+
30+
------------------------------------------------------------------------------------------------------------------------
31+
32+
------------------------------------------------------------------------------------------------------------------------
33+
### <a name="usage"></a> Usage
34+
-
35+
36+
------------------------------------------------------------------------------------------------------------------------
37+
38+
------------------------------------------------------------------------------------------------------------------------
39+
### <a name="commands"></a> Commands
40+
-
41+
42+
------------------------------------------------------------------------------------------------------------------------
43+
44+
------------------------------------------------------------------------------------------------------------------------
45+
### <a name="contributing"></a> Contributing
46+
-
47+
48+
------------------------------------------------------------------------------------------------------------------------
49+
50+
------------------------------------------------------------------------------------------------------------------------
51+
### <a name="license"></a> License
52+
-
53+
54+
------------------------------------------------------------------------------------------------------------------------
55+
56+
------------------------------------------------------------------------------------------------------------------------
57+
### Acknowledgements](#acknowledgements)
58+
-
59+
60+
------------------------------------------------------------------------------------------------------------------------
61+
62+
------------------------------------------------------------------------------------------------------------------------
63+
### <a name="faq"></a> FAQ
64+
-
65+
66+
------------------------------------------------------------------------------------------------------------------------

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,5 +550,4 @@ Sample commands:
550550
- Bugfixes for stability and file handling(Making sure files are removed when they should be)
551551
- Add support for more APIs
552552
- Live audio recording + transcription
553-
- Documentation for each of the functions exposed.
554-
- They all are pretty straightforward, but I'd like to make it easier to understand what's going on.
553+
- RAG support

0 commit comments

Comments
 (0)