Add note to Web App README to clarify about uncommited changes in api…

… ref dir
e2b-dev · Nov 18, 2024 · 28c8ddc · 28c8ddc
1 parent 7d93190
commit 28c8ddc
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/apps/web/README.md b/apps/web/README.md
@@ -10,3 +10,5 @@ Each package has its own API reference generator found in `{package-dir}/scripts
 When pushed to `main`, a [github workflow](../../.github/workflows/generate_api_ref.yml) checks for diffs in the [packages](../../packages) folder, and if any are found, the API reference generator is run and the result is auto-commited the incoming branch.
 
 Finally, when building or running the dev server, a [prebuild](./prebuild.js) step is run beforehand to generate the API reference TOCs and routes in the [api-reference](./src/app/(docs)/docs/api-reference) directory. This can also be run manually using `npm run prebuild`.
+
+note: sometimes you may see uncommited changes or untracked files in the [api-reference](./src/app/(docs)/docs/api-reference) directory, this is fine and the files can be ignored.