Skip to content

Migrate doc/ from Texy to Markdown#155

Merged
JanTvrdik merged 3 commits intomasterfrom
migrate-docs-to-markdown
Feb 25, 2026
Merged

Migrate doc/ from Texy to Markdown#155
JanTvrdik merged 3 commits intomasterfrom
migrate-docs-to-markdown

Conversation

@JanTvrdik
Copy link
Copy Markdown
Member

Summary

  • Convert all 6 documentation files from Texy format (.texy) to standard Markdown (.md)
  • Translate Texy-specific syntax: "text":url links, /-- \-- code blocks, [* image *] embeds, underline headings, .[h4] annotations
  • No content changes — purely a format migration

Test plan

  • Verify all .md files render correctly on GitHub
  • Confirm internal cross-links between doc pages resolve properly
  • Check that the image reference in plain-php.md displays correctly

Convert all documentation files from Texy format (.texy) to standard
Markdown (.md). Texy-specific syntax (link formats, code block
delimiters, image embeds, heading styles) has been translated to their
Markdown equivalents.
Copilot AI review requested due to automatic review settings February 25, 2026 19:10
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Migrates the project documentation in doc/ from Texy-style markup to GitHub-renderable Markdown, updating headings, links, code fences, and image embeds.

Changes:

  • Converted Texy-style headings and annotations to Markdown heading syntax across docs.
  • Replaced Texy code blocks (/-- ... \--) with fenced Markdown code blocks (including language tags where applicable).
  • Migrated Texy link/image syntax to standard Markdown links and images; replaced menu.texy with menu.md.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
doc/symfony-console.md Converted headings and code blocks to Markdown.
doc/symfony-bundle.md Converted headings, code fences (PHP/YAML), and internal link to Markdown.
doc/plain-php.md Converted code fencing and image embed to Markdown.
doc/nette-extension.md Converted headings, code fences, and external/internal links to Markdown.
doc/menu.texy Removed legacy Texy menu.
doc/menu.md Added Markdown menu with updated intra-doc links.
doc/default.md Converted headings, rules, and code blocks to Markdown; updated link syntax.
Comments suppressed due to low confidence (3)

doc/nette-extension.md:12

  • The fenced block is marked as yaml, but the example uses tab indentation. YAML disallows tabs for indentation, so readers copying this may get invalid YAML. Consider converting tabs to spaces, or change the fence language to something accurate for Nette config (e.g., neon/text).
    doc/nette-extension.md:36
  • Same as above: this block is labeled yaml, but it contains tab-indented config (and placeholders) that won't validate as YAML. Either convert indentation to spaces (valid YAML) or switch the code fence language to match the intended format.
    doc/default.md:58
  • Grammar: “Migrations can written as file …” is missing words and reads awkwardly. Consider rewriting (e.g., “Migrations can be written as files …”) to avoid confusing readers during the format migration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

composer.json requires symfony/* ^4.4, so the app/AppKernel.php
registration path for Symfony < 4 is no longer applicable.
- Fix subject-verb agreement ("Nextras Migrations ships/defines/comes")
- Add missing articles (a/the) throughout
- Fix missing "be" in "can be written"
- Add missing commas after introductory phrases
- Fix "options" → "option" (singular)
@JanTvrdik JanTvrdik merged commit e8b6478 into master Feb 25, 2026
10 checks passed
@JanTvrdik JanTvrdik deleted the migrate-docs-to-markdown branch February 25, 2026 19:18
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