Skip to content

Commit 67bf68d

Browse files
Re-render of documentation.txt
1 parent 38d9852 commit 67bf68d

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/static/documentation.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,6 @@ mypy .
129129

130130
## Developing with LLMs
131131

132-
In line with the [llms.txt standard](https://llmstxt.org/), we have exposed the full Markdown-formatted project documentation as a [single text file](https://promptlytechnologies.com/docs/static/llms.txt) to make it more usable by LLM agents.
133-
134132
``` {python}
135133
#| echo: false
136134
#| include: false
@@ -189,11 +187,15 @@ output_dir = base_dir / 'docs' / 'static'
189187
output_dir.mkdir(parents=True, exist_ok=True)
190188

191189
# Write the concatenated content to the output file
192-
output_path = output_dir / 'llms.txt'
190+
output_path = output_dir / 'documentation.txt'
193191
with open(output_path, 'w', encoding='utf-8') as f:
194192
f.write(final_content)
195193
```
196194

195+
In line with the [llms.txt standard](https://llmstxt.org/), we have provided a Markdown-formatted prompt—designed to help LLM agents understand how to work with this template—as a [text file](docs/static/llms.txt). One use case for this file is to rename it to `.cursorrules` and place it in your project directory is using the Cursor IDE (see the [Cursor docs](https://docs.cursor.com/context/rules-for-ai) on this for more information).
196+
197+
We have also exposed the full Markdown-formatted project documentation as a [single text file](docs/static/documentation.txt) for easy downloading and embedding.
198+
197199
## Contributing
198200

199201
Your contributions are welcome! See the [issues page](https://github.com/promptly-technologies-llc/fastapi-jinja2-postgres-webapp/issues) for ideas. Fork the repository, create a new branch, make your changes, and submit a pull request.
@@ -690,7 +692,9 @@ We find that mypy is an enormous time-saver, catching many errors early and grea
690692

691693
### Developing with LLMs
692694

693-
In line with the [llms.txt standard](https://llmstxt.org/), we have exposed the full Markdown-formatted project documentation as a [single text file](https://promptlytechnologies.com/docs/static/llms.txt) to make it more usable by LLM agents.
695+
In line with the [llms.txt standard](https://llmstxt.org/), we have provided a Markdown-formatted prompt—designed to help LLM agents understand how to work with this template—as a [text file](static/llms.txt). One use case for this file is to rename it to `.cursorrules` and place it in your project directory is using the Cursor IDE (see the [Cursor docs](https://docs.cursor.com/context/rules-for-ai) on this for more information).
696+
697+
We have also exposed the full Markdown-formatted project documentation as a [single text file](static/documentation.txt) for easy downloading and embedding.
694698

695699
## Project structure
696700

0 commit comments

Comments
 (0)