I've consistently faced an issue with the auto-docs directory.

[Shofikul Islam]

@palisadoes

I've successfully achieved 100% test coverage for EventRegistrants.

However, I've consistently faced an issue with the auto-docs directory, which causes git checkout failures due to uncommitted changes. This hinders branch switching and maintaining a clean working directory.

Given auto-docs is auto-generated, could we discuss adding it to .gitignore or another solution to prevent these conflicts?

Thanks!

 

[palisadoes]

1. Do not bypass the pre-commits steps.
2. Use the generate command in `package.json` to overcome the issue
3. The online documentation is important.

 

[Rawad]

Hey @Shofikul Islam,
I ran into the exact same issue, and it turned out the auto-doc generator compares your local docs/auto-docs against what's currently on develop. So, if your local version isn’t in sync with the latest develop docs, git shows hundreds of modified .md files which blocks checkout, committing etc.

Here’s what worked for me:
1. Reset your local auto-docs to match origin/develop:

git checkout origin/develop -- docs/docs/auto-docs

2. Make sure Git doesn’t flip line endings (Windows users only)

git config core.autocrlf false

3. Reinstall dependencies and regenerate docs cleanly:

npm ci
npm run generate-docs

After this, it went from 1400+ files to only the 10–15 updated md files depending on the spec file and had no checkout or commit failures.