API Documentation Sync

Problem: Documentation tools like Gitbook & Mintlify exists, but impossible to keep track when the API changes or features, so should the Docs change. Huge bottleneck on large projects with changes every single damn day.

(Also these tools have ridiculous cost. Sure, cost shouldn't be deciding factor to compete, but Mintlify costs 100$ for custom css for fucks sake!)

For APis it is simple (index models, controllers and notice changes), but having the Docs for features is hard. Syncing would be hard, but game changer if possible to find.

• Possible Solutions:

1. CI/CD on version control (Github / BitBucket) -> Update API docs from indexed Schema, routes, controllers, etc.
2. For Features: Possible use LLM on indexed pages with main features? Would require some sort of human feedback, but better than manual updates.

Visual Testing of APIs across Distributed Systems

• Problem: Individual Testing tools like Unit testing tools (language specific) like Jest, Mocha, Junit, etc exists. But main testing issues comes in Integration / API testing, where there's external testing. Its difficult to run tests.
• Visual testing APIs allow better view over collection based testing (Insomnia, Postman) in Distributed Systems
• Would also replace need of having testing tools + monitoring tools as flow of app and issues would be determined very quickly, with visual monitoring of performance & stuff.

Automated End - To - End Testing

• Problem: Similar to Visual testing for API, a visual testing for End - to - End testing would be good.
• Context: End testing mimics user behaviour (puppeteer, selenium) to run automated tests to find bugs / measure performance.
• Creating Visual Test Scripts would speed things up

Issue: These are very very low level tests (could be a tarpit idea), hence why no tool exists possibly? Should validate.. and there'll still be intervention, will just simplify work not automate 100%

Infra Simulation Tool for System HLD

• Problem: Lots of time is taken testing & planning architecture, setting up tests systems for performance / flow, etc. & Tons of revisions due to optimisations. Would be nice to be able to simulate rather than make hypothesis / spend huge time on calculations.

• AIM to visualize architecture (NOTE: Not diagram, whiiteboard or Diagram Code tool) & process monitor in completely simulated systems.

• Can AIM for Orchestration platforms first (simpler).

• Reference: Cisco Packet Tracer