Skip to content

prepare files for website#24

Merged
mbreiser merged 1 commit into
reiserlab:mainfrom
floesche:prepare-docs
Apr 29, 2026
Merged

prepare files for website#24
mbreiser merged 1 commit into
reiserlab:mainfrom
floesche:prepare-docs

Conversation

@floesche
Copy link
Copy Markdown
Member

@floesche floesche requested a review from mbreiser April 27, 2026 18:56
@floesche
Copy link
Copy Markdown
Member Author

This will put the documentation in some preliminary structure. Can be changed later.

@mbreiser mbreiser merged commit a1cd1a1 into reiserlab:main Apr 29, 2026
@mbreiser
Copy link
Copy Markdown
Contributor

mbreiser commented Apr 29, 2026

Thanks @floesche — merged.

A couple of quick FYIs (no action needed unless you want to):

  1. Five sibling pages under "MATLAB Tools" share nav_order: 20 (experiment_pipeline_guide, pattern_library_convention, pattern_tools_quickstart, sd_card_deployment_notes, yaml_protocol_documentation), so Just-the-Docs will sort them alphabetically. If you'd like a specific order, distinct values (e.g., 20/30/40/50/60) would do it — happy either way.

  2. Pushed two small follow-ups on main:

    • Added matching front matter to patterns/README.md so it joins the section (nav_order: 70).
    • Trimmed two stale "See also" bullets at the bottom of g6_quickstart.md that pointed to docs/g6_migration_plan.md (moved to docs/development/) and docs/g6_led_mapping.md (doesn't exist yet).

Let me know if you'd rather adjust either.

@floesche
Copy link
Copy Markdown
Member Author

Thanks @mbreiser.

Re 1: I set the nav_order to the same value since I didn't have a preference about the order when I added the pages and was fine with the alphabetic order. If you have a preference, please feel free to give matching values.

Re 2: I am currently ignoring README.md for the website and instead have them as "landing pages" when you go to the repository itself. I would usually create a separate landing page for the website. In my idea, the README.md would contain a condensed version of everything about the repository (or folder in your case) in one file, while a webpage landing page would guide the reader through the rest of the documentation pages. I recommend creating a separate docs/pattern.md file instead, at this point with content very similar to the README.md.

mbreiser added a commit that referenced this pull request Apr 29, 2026
Per Frank's review feedback on PR #24 (READMEs are repo-only landing
pages; the unified docs site should have separate docs/<topic>.md guides),
revert the front matter on patterns/README.md and add docs/patterns.md
with equivalent content for the website.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mbreiser
Copy link
Copy Markdown
Contributor

Thanks @floesche, that makes sense. Pushed a51fe18 — reverted the front matter on patterns/README.md and added a dedicated docs/patterns.md per your suggestion, so the README stays repo-internal and the unified site has its own page.

Re: 1, no preference on order, alphabetical is fine.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants