docs: Optimizes Technical Docs for LLMs & Vectorization

[Ed-Marcavage]

Relates to

• chore: Document Missing Plugin Documentation and Examples #1200
• Improves Agentic Eliza Plugin Documenter - Multilingual (e.g., English, Spanish, French) #1675
• https://docs.kapa.ai/blog/optimizing-technical-documentation-for-llms#3-include-troubleshooting-faqs

Risks

• Minimal risk, malformed JSDoc has been mitigated. Only risk is LLM hallucinates and writes incorrect documentation.

✓ JSDoc comment in portfolioProvider.ts was fixed using regex patterns
✓ JSDoc comment in token.ts was fixed using regex patterns
✓ JSDoc comment in trustScoreProvider.ts was fixed using regex patterns

Background

What does this PR do?

• Optimizes Technical Docs for LLMs in the generated README file
• Adds support for JSDOC for objects (Actions/Providers)

What kind of change is this?

• Improvements

Documentation changes needed?

My changes do not require a change to the project documentation. - Its created agenticly

Testing

• https://github.com/AudixAI/eliza-jsdoc/blob/aa1510e1062dfa5b7b38af17e351457358e5e0bf/packages/plugin-bootstrap/README-automated.md#faq

Where should a reviewer start?

• src/index.ts

Detailed testing steps

Detailed testing steps

• Ensure JSDoc & Readme match the plugin being scanned

Deploy Notes

• Set GH_PAT & OPENAI_API_KEY in github actions as secret env variables

Discord username

• 0xbuildinpublic