Skip to content

Improve GitHub About and README readability #4

Open

Description

@RayLi-Muye

Problem

First-time GitHub visitors do not yet get a fast enough overview of what this repository contains, how to work with it safely, and which documents own SEO, deployment, and client-project operating rules. The repository About metadata is also stale: the description is informal, the homepage points to an old Vercel URL, and no developer-facing topics are set.

Scope

  • Refresh README.md with a clearer developer-facing information architecture:
    • one-sentence project positioning
    • Jump To / quick links
    • purpose and public surfaces
    • tech stack
    • local setup and common commands
    • repository structure
    • SEO and metadata maintenance notes
    • deployment boundary and review workflow
    • documentation index
  • Update GitHub About metadata with neutral developer-facing wording:
    • description: Developer repository for the MIST Architects bilingual portfolio website.
    • homepage: https://mist-arch.com
    • topics: nextjs, react, typescript, architecture-portfolio, bilingual-site, playwright, github-actions, alibaba-cloud
  • Keep this as documentation/repository metadata only.

Out of scope

  • No website runtime UI changes.
  • No SEO metadata, brand copy, visual direction, production deployment, Bing/Webmaster state, or customer-visible site behavior changes.
  • No merge, release, deploy, or production credential/account operation.
  • No changes to the existing SEO PR [codex] Improve Bing metadata image crawlability #3.

Acceptance criteria

  • README.md lets a first-time developer understand the project purpose, stack, setup, commands, structure, SEO maintenance entry points, deployment boundary, review workflow, and docs index within a short skim.
  • GitHub About description, homepage, and topics match the metadata listed above.
  • A separate topic branch and PR link this issue.
  • GitHub Actions CI runs on the PR.
  • Documentation changes pass git diff --check.

Docs/tests

  • Docs: README.md plus docs/DEVELOPMENT_LOG.md if the README/About refresh is implemented.
  • Tests/checks: git diff --check; full CI is expected through GitHub Actions on the PR.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions