Skip to content

Add GitHub Pages publishing instructions to README - #1

Open
Waganawa-Megumin wants to merge 1 commit into
masterfrom
codex/add-github-pages-deployment-steps-to-readme
Open

Add GitHub Pages publishing instructions to README#1
Waganawa-Megumin wants to merge 1 commit into
masterfrom
codex/add-github-pages-deployment-steps-to-readme

Conversation

@Waganawa-Megumin

Copy link
Copy Markdown
Owner

Motivation

  • Provide simple step-by-step guidance for publishing the repository via GitHub Pages assuming index.html is at the repository root.

Description

  • Added README.md containing instructions to open the repository SettingsPages, set Build and deployment Source to Deploy from a branch, select the Branch (e.g., main) and Folder /root, save, and then visit the shown GitHub Pages URL to verify the site.

Testing

  • No automated tests were run for this documentation-only change.

Codex Task

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a6d6c6b7b3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
1. GitHub の対象リポジトリを開きます。
2. `Settings` → `Pages` を開きます。
3. `Build and deployment` の `Source` を `Deploy from a branch` に設定します。
4. `Branch` を公開したいブランチ(例: `main`)、`Folder` を `/root` に設定します。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use the actual Pages root folder option

When the site files live at the repository root, GitHub Pages' branch source folder is / / /(root), not /root; the official docs describe the source folder as either the repository root (/) or /docs. Following this step as written sends users looking for a non-existent /root folder option, so they cannot complete the documented publishing flow without guessing the intended setting.

Useful? React with 👍 / 👎.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant