Illustration of source folders, version history and project documentation.

Technical article

Project Repository Maintenance Guide

Project pages should explain what the project is, who built it, its current status and where the maintained source lives.

Project links

Make the relationship between repo, live site and author clear

A project note is easier to check when the repository, project page, main website case study and author profile link to each other. Explain the evidence clearly, leave private files out and label stale or unsupported material.

Archive status README context Safe downloads Case study link Recrawl notes

Archive setup

Start with the public repository page

Many people first encounter a project through a profile link, a repository page or a case-study card. The archive should quickly explain what the project does, whether the snapshot is current, what files are safe to download and which canonical page gives the human-friendly context.

Archive description

Use a specific one-sentence description. Include the project type, purpose and status without broad keyword lists or unsupported audience claims.

Canonical project URL

Point each source page to the strongest project note or case study. That keeps the archive useful without making raw downloads carry the whole explanation.

Safe archive files

Keep ZIP and bundle downloads separate from indexable HTML pages, and keep raw archives out of search snippets where `noindex`/`noarchive` is appropriate.

Snapshot notes

Record the date, source branch or bundle and any limitations so future profile copy does not imply a project is newer or more complete than it is.

README structure

Write the README like a compact project brief

A useful README is both a developer entry point and a public project overview. It should help a future collaborator, recruiter, client or search engine understand what is real without needing private context.

What it does

Open with the problem, intended audience and current status. If the project is experimental, say so plainly.

Related links

Link to the project page, main-site case study, profile page and any relevant documentation. Avoid dumping every profile link into every archive note.

Setup and stack

Include installation steps, environment notes, major dependencies, data sources and deployment notes where they are relevant and safe to publish.

Limitations

Known limits, data caveats and maintenance notes build more trust than pretending a side project is a finished enterprise product.

Live page SEO

Give the public repository page clear search metadata

A public repository page can be lightweight and still be understandable. Each project-note page should tell search engines and readers the title, description, canonical URL, preview image, author relationship and where to find the source.

Title and description

Write a page title that names the project and a meta description that explains the practical value. Avoid generic titles like "Home" or "React App".

Canonical and sharing tags

Use a self-canonical URL for the project page and Open Graph/Twitter tags so profile posts and project links preview cleanly.

Structured data

Use WebSite, SoftwareApplication, CreativeWork or WebApplication schema only where it genuinely fits. Link the author entity consistently.

Project links

Include visible links to the repository, detailed case study and author profile. The loop should be clear without overwhelming the page.

Project records

Keep useful records for profiles, CVs and future updates

Project pages become more useful when the evidence is durable. Screenshots, validation results, commit hashes and short case-study notes make it easier to reuse the project accurately on LinkedIn, CVs, directories and personal profile pages later.

Screenshot set

Capture the homepage and one or two important states. Keep filenames dated so they can be tied back to the project state at that time.

Validation notes

Record HTTP status, canonical URL, key links, schema parsing and sitemap state. A small repeatable check beats a one-off memory.

Case-study summary

Write a short public case study covering the problem, build choices, limitations and what the project demonstrates technically.

Profile reuse

Use the same evidence-backed wording across profile pages, repository copy, CV project sections and external platform drafts.

Keep the public project pages connected

The repository should link to the live site and case study. The live site should link to the repository and case study. The main website should link to both. Each link should help the reader find useful context.

Existing project pages

Improve the pages that already exist

Start with the pages already linked from the project: the repository index, README-style note, downloadable snapshot, screenshots and main-site case study. Keep them consistent with the live page instead of creating thin duplicates.

First screen context

Open with what the project does, why it exists, its current status, live URL, source status and known limits.

Description and labels

Use accurate labels and a concise description so visitors can classify the archive quickly: source snapshot, project note, prototype or maintained reference.

Homepage and social preview

Set the homepage to the live project or canonical case study, and use a preview image that shows the actual project rather than a vague graphic.

Maintenance status

If the project is archived, experimental, private prototype or in development, say so in the README and the live page.

Canonical choice

Decide which URL is the main reference before publishing

One project can have several public URLs: the repository, the hosted project page, a custom domain and a main-site case study. That can work when the canonical URLs, links and sitemap entries do not conflict. Pick the main reference for each job and make the links, canonicals, sitemap entries and profile links support that decision.

Archive as source

Use the archive as the source-code and status record. It should link to the live page and the main-site case study.

Live page as experience

Use the live page to show the project experience, screenshots, public demo or documentation in a way that works outside the repository interface.

Main site as context

Use the project note on the main website for background, current status and links to the maintained source.

Custom domain as identity

Use a custom domain only when the project needs its own durable identity and the DNS, HTTPS, canonical and Search Console setup can be maintained.

Launch verification

Check the deployed page like a small production site

Repositories can feel informal, but a public project page still deserves a launch check. A broken title, missing canonical, stale project link or unverified custom domain can make the current version difficult to find.

Project references

Useful references for project repositories

Keep these references beside the project handover. The repository pages explain what is available, while Google's canonical guidance explains how consistent URLs help search engines choose the preferred page.

Next steps

Connect project pages to audits, launch checks and case studies

Once the repository and project page agree, use the resources below for technical checks, launch steps, case-study updates and ongoing maintenance.

Technical SEO audit checklist

Use the technical audit when a project page needs canonical, indexing, sitemap, JSON-LD, internal-link or Search Console checks.

Local website launch checklist

Use the launch tool to turn a project-site release into repeatable preflight, publishing, rollback and post-launch checks.

John Finnerty repository

Use the repository to check project source pages, archive status, safe downloads, README-style notes and public project positioning.

Project Jaunt case study

Use this case study when the project is a diagnostic tool, technical workflow, open-source utility or small public site.

SEO consulting NZ

Use the SEO service page when a project page needs broader site structure, crawl checks or search measurement.

Project background

Help readers understand the project and its author

Project notes should help a reader understand who made the work, where the source lives, what status it has and what the project actually does. Link to the current About and Projects pages as well as the code or archive.

Current profile

About John Finnerty explains the author's technical consulting background and current work.

Projects page

The projects page is the main directory for project notes, repositories and case studies.

Example case study

Care Finder Aotearoa shows how a project note can connect source, development references and careful context.

Local and national relevance

The New Zealand profile links the project work with John's broader New Zealand services and background.

Help with your next step

Want help applying these checks to your website?

Send the website address and the customer enquiry you want it to support. I can help identify the page, content or technical changes worth making first.