docs: Update testing principles with e2e guidance

Created by: umpox

Description

Closes https://github.com/sourcegraph/sourcegraph/issues/30174

Our E2E tests are still useful, but we want to avoid using them where possible. This PR adds a small additional warning to help encourage that.

Test plan

N/A - Docs only change.