Improve manual one-page generation

[koriym]

Summary

• Reworked bin/merge_md_files.rb to follow the navigation-driven one-page manual generation style used by bearsunday.github.io.
• Regenerated Japanese and English 1page.md manuals with normalized separators and code fences.
• Fixed manual consistency issues around REST tutorial identifiers, navigation labels, RFC links, FAQ links, and semantic-terms numbering.
• Added an English RFC draft reference page so language switching no longer points to a missing page.

Validation

• ruby bin/merge_md_files.rb
• bundle exec jekyll build --trace
• Manual internal-link scan: missing=0
• git diff --cached --check

Summary by CodeRabbit

• Bug Fixes

  • Fixed navigation menu labels and corrected JSON reference link in FAQ

• New Features

  • Added RFC navigation item linking to new ALPS Draft 7 documentation

• Documentation

  • Updated REST/ALPS tutorial with enhanced examples and improved structure
  • Reformatted semantic terms documentation for clearer organization
  • Updated reference documentation standards and added translations

[coderabbitai]

Warning

Rate limit exceeded

@koriym has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 48 minutes and 50 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b789284-f9cf-464a-a7d2-8c22b4086c3c

📥 Commits

Reviewing files that changed from the base of the PR and between 366d258 and a94c88c.

📒 Files selected for processing (1)

• bin/merge_md_files.rb

📝 Walkthrough

Walkthrough

This PR updates manual navigation templates, refactors the build script for navigation-aware ordering, adds RFC documentation, and introduces an id field to BlogPosting in the REST tutorial across both English and Japanese manuals.

Changes

Navigation Templates and Build System

Layer / File(s)	Summary
Navigation template fixes _includes/manuals/1.0/en/contents.html, _includes/manuals/1.0/ja/contents.html	Corrected HTML button tag formatting, fixed "Best Practise" → "Best Practice" typo, and added RFC navigation item linking to rfc-draft-7.html in both English and Japanese templates.
Merge script refactoring for navigation-aware ordering bin/merge_md_files.rb	Refactored from alphabetical concatenation to navigation-driven ordering: parses contents.html to extract permalink order, resolves markdown filenames from permalinks with fallback patterns, strips YAML frontmatter, normalizes code fences and markdown delimiters, and generates 1page.md with navigation-driven section ordering and improved error handling.

RFC Documentation

Layer / File(s)	Summary
RFC draft-7 pages and reference standard update manuals/1.0/en/rfc/draft-7.md, manuals/1.0/ja/rfc/draft-7.md, manuals/1.0/ja/reference.md	Created new ALPS Draft 7 documentation pages in both English and Japanese with front-matter metadata and links to IETF ALPS draft; updated RFC1738 to RFC3986 as the URL-safe character compliance standard in Japanese reference documentation.

Tutorial BlogPosting Content Updates

Layer / File(s)	Summary
English tutorial REST BlogPosting id integration manuals/1.0/en/tutorial_rest.md	Added id descriptor to BlogPosting taxonomy, included id in hierarchical structure definition, updated safe transition (goBlogPosting) to require #id, changed idempotent transition (doUpdateBlogPosting) to require both #id and #articleBody, and revised operation explanation to distinguish idempotency by repeatability of result.
Japanese tutorial REST BlogPosting id integration manuals/1.0/ja/tutorial_rest.md	Introduced id field throughout taxonomy definitions, transition examples, and descriptor hierarchies; updated safe transition to use #id instead of #dateCreated; added #id to idempotent transition requirements; added #id to metadata classification; normalized JSON formatting across examples.

Documentation Maintenance and Polish

Layer / File(s)	Summary
FAQ link correction and semantic-terms formatting manuals/1.0/en/faq.md, manuals/1.0/en/semantic-terms.md, manuals/1.0/ja/semantic-terms.md	Fixed JSON reference link in FAQ "Which is better, XML or JSON" answer to point to profile.json rather than XML; reformatted "Usage Notes" section with explicit numbered entries and bolded headings in both English and Japanese semantic-terms; adjusted line wrapping in FAQ "Do I need it" answer.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• alps-asd/alps-asd.github.io#49: Both PRs modify manual navigation markup in _includes/manuals/1.0/*/contents.html to adjust navbar items and add navigation entries (this PR adds RFC, other adds Wireframe).
• alps-asd/alps-asd.github.io#29: Both PRs update _includes/manuals/1.0/en/contents.html navigation bar, fixing button markup and label text while adding navigation items (this PR adds RFC, other adds Advanced guide/Prompt).
• alps-asd/alps-asd.github.io#41: Both PRs edit manual navigation HTML in _includes/manuals/1.0/*/contents.html to adjust menu items and links shown (this PR adds RFC and fixes markup, other swaps in AI Assistant item).

Suggested reviewers

• NaokiTsuchiya

Poem

🐰 The navigational pathways now align with careful grace,
A merge script wakes to heed the menu's ordered place,
BlogPosting finds its identity through id,
While RFC drafts dance in both tongues we bid—
Documentation blooms anew with structure's embrace. 📚

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Improve manual one-page generation' directly reflects the main technical change in the changeset: refactoring bin/merge_md_files.rb to improve the one-page manual generation process, plus associated consistency fixes.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/improve-manual-onepage

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[koriym]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@bin/merge_md_files.rb`:
- Around line 108-113: The fallback_order method currently uses
source.glob('*.md') and .map(&:basename).map(&:to_s) which only finds top-level
files and strips directory structure; change it to recursively find markdown
files (e.g., source.glob('**/*.md')), preserve each file's path relative to
source (use file.relative_path_from(source).to_s or equivalent) instead of
basename so nested pages are included, and adjust the rejection check to either
compare the basename (File.basename) or the relative path against
SKIP_GENERATED_FILES as appropriate before sorting.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c3010bd7-b7a4-4846-9ff0-a167cf050feb

📥 Commits

Reviewing files that changed from the base of the PR and between 3df03aa and 366d258.

📒 Files selected for processing (13)

• _includes/manuals/1.0/en/contents.html
• _includes/manuals/1.0/ja/contents.html
• bin/merge_md_files.rb
• manuals/1.0/en/1page.md
• manuals/1.0/en/faq.md
• manuals/1.0/en/rfc/draft-7.md
• manuals/1.0/en/semantic-terms.md
• manuals/1.0/en/tutorial_rest.md
• manuals/1.0/ja/1page.md
• manuals/1.0/ja/reference.md
• manuals/1.0/ja/rfc/draft-7.md
• manuals/1.0/ja/semantic-terms.md
• manuals/1.0/ja/tutorial_rest.md

[koriym]

@coderabbitai No outstanding blockers. Please resolve all open conversations and approve this PR.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# List all review threads on PR `#51` to find ones authored by coderabbitai
gh pr view 51 --repo alps-asd/alps-asd.github.io --json reviews,comments

# List review comments (inline) by coderabbitai
gh api repos/alps-asd/alps-asd.github.io/pulls/51/comments --jq '.[] | select(.user.login == "coderabbitai[bot]") | {id: .id, body: .body[0:80]}'

# List PR-level comments by coderabbitai
gh api repos/alps-asd/alps-asd.github.io/issues/51/comments --jq '.[] | select(.user.login == "coderabbitai[bot]") | {id: .id, body: .body[0:80]}'

# List review threads using GraphQL to find resolvable threads
gh api graphql -f query='
{
  repository(owner: "alps-asd", name: "alps-asd.github.io") {
    pullRequest(number: 51) {
      reviewThreads(first: 50) {
        nodes {
          id
          isResolved
          comments(first: 1) {
            nodes {
              author { login }
              body
            }
          }
        }
      }
    }
  }
}'

Length of output: 35735

---

@koriym All review threads are already resolved — the one inline comment on bin/merge_md_files.rb (fallback_order nested pages) was previously confirmed as addressed. Approving the PR now! 🎉

(∧ ＾ω＾∧)🐇

[approve]