Skip to content

Commit b6788a5

Browse files
committed
docs: add AI section to docs and simplify the private package check,
refs #5
1 parent 42c1b8b commit b6788a5

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,16 @@ At the moment, the library **does not** provide security features like automatic
8686

8787
Also, do not forget about **XSS prevention**, when rendering untrusted data with custom components!
8888

89+
## AI assistance
90+
91+
The library and all its dependencies are registered at [Context7](https://context7.com/volfpeter).
92+
93+
To get good AI assistance, all you need to do is register the Context7 MCP server in your coding tool and tell the agent to use it.
94+
95+
If you are starting a new project, you can additionally point the agent at one of the example applications in the [repository](https://github.com/volfpeter/holm). With all this context and detailed instructions of the project you want to build, it will get you started quickly.
96+
97+
Because of the similarity with Next.js and React, and the standard use of FastAPI and other dependencies, you can expect good results, both for vibe coding or inline completion.
98+
8999
## Development
90100

91101
Development setup:

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,16 @@ At the moment, the library **does not** provide security features like automatic
7777

7878
Also, do not forget about **XSS prevention**, when rendering untrusted data with custom components!
7979

80+
## AI assistance
81+
82+
The library and all its dependencies are registered at [Context7](https://context7.com/volfpeter).
83+
84+
To get good AI assistance, all you need to do is register the Context7 MCP server in your coding tool and tell the agent to use it.
85+
86+
If you are starting a new project, you can additionally point the agent at one of the example applications in the [repository](https://github.com/volfpeter/holm). With all this context and detailed instructions of the project you want to build, it will get you started quickly.
87+
88+
Because of the similarity with Next.js and React, and the standard use of FastAPI and other dependencies, you can expect good results, both for vibe coding or inline completion.
89+
8090
## Development
8191

8292
Development setup:

holm/app.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,10 @@ def is_excluded(path: Path) -> bool:
139139
"""Returns whether the given file or package path should be excluded from the application."""
140140
rel_path = path.relative_to(config.root_dir)
141141
return any(
142-
p
143-
for p in rel_path.parts
144142
# Exclude if a path segment starts with an underscore but does not end with one.
145143
# Path segments that both start and end with an underscore represent path parameters!
146-
if p.startswith("_") and not p.endswith("_")
144+
p.startswith("_") and not p.endswith("_")
145+
for p in rel_path.parts
147146
)
148147

149148
return {

0 commit comments

Comments
 (0)