Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various README improvements #585

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Various README improvements #585

wants to merge 6 commits into from

Commits on Jul 21, 2024

  1. Regroup links to the footer

    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    c21c48f View commit details
    Browse the repository at this point in the history

  2. Explain how to check spellings locally

    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    b515043 View commit details
    Browse the repository at this point in the history

  3. Add missing link to where to view the site

    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    5ec48a9 View commit details
    Browse the repository at this point in the history

  4. Clarify the nature of the Docker alternative and add links 

    Importantly this pushes this option to being secondary and
clarifies which of the build steps it replaces.

Note that this also removes the instructions on how to use Docker.
If users are not already familiar with Docker & Docker Compose
then they are equally not equipped to judge the security posture
that it presents.
    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    5a27c36 View commit details
    Browse the repository at this point in the history

  5. Un-number these points to avoid future diffs if things change

    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    dd0cd2e View commit details
    Browse the repository at this point in the history

  6. Expand the spellings section to cover all validation checks

    @PeterJCLaw
    PeterJCLaw committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    7f6d03b View commit details
    Browse the repository at this point in the history