Skip to content

Docs/professional readme - #17

Merged
AmzBG merged 13 commits into
mainfrom
docs/professional-readme
Aug 11, 2026
Merged

Docs/professional readme#17
AmzBG merged 13 commits into
mainfrom
docs/professional-readme

Conversation

@AmzBG

@AmzBG AmzBG commented Aug 11, 2026

Copy link
Copy Markdown
Owner

Description

  • Replaces the generic starter README with a complete, product-focused presentation of Deployfolio.
  • Positions Deployfolio as a verified engineering portfolio platform for developers and an evidence-based discovery tool for hiring teams.
  • Adds a seven-screen widescreen product tour with persistent role labels and smooth full-color wipe transitions grouped by developer, recruiter, and administration personas.
  • Adds real application screenshots for natural-language semantic search, multi-technology filtering, candidate pipeline management, AI-assisted profile writing, authenticated developer-profile review, and platform administration.
  • Uses a consistent Murex recruiter demo identity across the workspace, search, and candidate pipeline captures.
  • Documents the architecture, technology stack, repository structure, local setup, seeded accounts, environment configuration, security model, quality gates, and deployment paths.
  • Updates badges and links to use the canonical AmzBG/Deployfolio repository.
  • Keeps the change limited to documentation and media assets with no application behavior changes.

Link to issue or ticket

N/A - documentation and repository presentation update.

Steps to QA

  1. Open the rendered README.md.

  2. Confirm the opening GIF loads at full width and transitions through all seven product views.

  3. Verify both developer scenes appear first, followed by the complete recruiter journey and then administration, without cropped desktop layouts.

  4. Confirm recruiter-facing views consistently show the Murex account name and logo.

  5. Verify the workflow section shows:

    • The query something with artistic elements with semantically ranked project results.
    • The combined Next.js, React, and TypeScript technology filters.
    • The ordered SAVED, CONTACTED, ACCEPTED, and REJECTED candidate pipeline.
    • The Enhance with AI action in the developer profile editor.
  6. Confirm every screenshot, badge, internal link, and architecture diagram renders correctly.

  7. Confirm the README states that project pages are public while developer profiles require authentication.

  8. Run the repository quality gates:

    npx turbo run lint
    npx turbo run check-types
    npm run format:check

Screenshots

Product tour

Deployfolio widescreen product tour

Additional workflow captures

Natural-language project discovery

Deployfolio semantic project search

Candidate pipeline

Deployfolio recruiter candidate pipeline

AI-assisted profile writing

Deployfolio AI-assisted profile editor

Administration

Deployfolio administration console

@AmzBG AmzBG self-assigned this Aug 11, 2026
@AmzBG AmzBG added the documentation Improvements or additions to documentation label Aug 11, 2026
@AmzBG
AmzBG merged commit f37e1e8 into main Aug 11, 2026
1 check passed
@AmzBG
AmzBG deleted the docs/professional-readme branch August 11, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant