chore: Documentation of e2e

[biocodeit]

• Add documentation
• Add test structure
• Refactor code and file naming according to @Dancode-188 preference it needed

[biocodeit]

@Dancode-188 let me know how should i proceed with this. Let me have any suggestions with test structuring, renaming files, refactor code accordingly i will change the framework.

[Dancode-188]

Hey @biocodeit,

Yeah, we should get this documented. The structure from #41 has been in place for a couple weeks now, so it's a good time to capture how it works.

The current setup is solid - the three-tier structure (fixtures/ → object-models/ → tests/) with categorized test folders makes sense and has been working well. What we need is documentation that helps someone new understand why it's organized this way and how to add to it.

Here's what would be most useful:

1. e2e/README.md - Architecture overview

• The three layers and what each does (fixtures handle setup, object models encapsulate UI interactions, tests verify behavior)
• Why tests are organized into basic-function/, main-components/, user-workflows/
• The fixture merging pattern (fixtures/index.ts) - this is clever but not obvious to newcomers
• The base fixture auto-navigation - worth calling out

2. Contributing guide for tests
Something practical like:

• How to add a new test (which fixture to import, which object model to use)
• Naming conventions for test files and page objects
• When to create a new object model vs extending an existing one
• The locator strategy (you're using role-based selectors, which is good - worth documenting why)

3. Inline documentation for complex patterns

• ReqHelpers has a lot of locators - a comment explaining the sections would help
• The base fixture's page.goto() behavior could use a comment
• Maybe an example in fixtures/index.ts explaining mergeTests

Keep it practical - think "what would I want to know if I joined this project tomorrow?" You don't need to write a novel, just document what's there and why it works the way it does.

The current structure is good, file naming is consistent, organization makes sense. You don't need to refactor anything. Just document it.

You've got good judgment on this - write what you think would be helpful and open a PR. We can iterate on it if needed.

[biocodeit]

Hey @Dancode-188 , sorry for late response got back to work. Will try to complete this as per requirement