docs: document user API endpoint and add scripts section

[BadPirate]

No description provided.

[Copilot]

Pull Request Overview

This PR updates documentation for the user API endpoint and adds several new scripts to streamline development workflows. Key changes include refactoring the user provider component to separately manage session state, adding new testing and linting scripts, and updating supporting documentation and configuration files.

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/components/UserProvider.tsx	Refactored context state handling for session and user data with new signOut logic.
src/components/RootNav.tsx	Integrated new BreadCrumbs component and updated navigation with optional titles.
src/components/Page.tsx	Updated to pass title to RootNav.
src/components/BreadCrumbs.tsx	Added new breadcrumbs component for improved navigation.
scripts/lint.sh	Added a new linting script orchestrating Prettier, ESLint, and TypeScript checks.
playwright.config.ts	Enabled video recording and adjusted server command for test stability.
pages/api/user.ts	Introduced new API endpoint to fetch authenticated user details from the database.
pages/api/auth/[...nextauth].tsx	Refactored authentication configuration to use an external authOptions module.
package.json	Updated scripts and dependencies to support new features and testing workflows.
e2e/homepage.spec.ts & e2e/baseTest.ts	Refined e2e tests and introduced a custom base test for API context handling.
README.md & CONTRIBUTING.md	Updated documentation with information about the new user API and available scripts.
.vscode/settings.json, .husky/pre-commit, .github/workflows/ci.yml	Enhanced configuration for coding tools and CI/CD.
.env files & .devcontainer files	Updated environment variables and devcontainer dependencies for consistency.

Comments suppressed due to low confidence (1)

src/components/UserProvider.tsx:60

• The state update includes a property 'sessionLoading' that isn't defined in the UserContextType. Consider removing it or updating the type definition to include 'sessionLoading'.

setSessionUserContext((ctx) => ({ ...ctx, user: undefined, sessionLoading: false }))