Skip to content

fix: restore docs accidentally deleted in PR #4001 (electron-vite refactor) - #4196

Merged
Jocs merged 10 commits into
developfrom
fix/restore-deleted-docs
May 13, 2026
Merged

Jocs merged 10 commits into
developfrom
fix/restore-deleted-docs

Conversation

@Jocs

@Jocs Jocs commented May 13, 2026 •

Copy link
Copy Markdown
Member

Closes #

Summary

This PR restores files accidentally deleted in #4001 (electron-vite refactor) and reorganizes the documentation structure for better maintainability.

Changes

1. Restore accidentally deleted files

Files removed in #4001 that had no relation to the build system changes:

File Description
.github/CHANGELOG.md → docs/CHANGELOG.md Project changelog (858 lines)
.github/CODE_OF_CONDUCT.md → docs/dev/CODE_OF_CONDUCT.md Community guidelines
.github/CONTRIBUTING.md Contributor guide
.github/FUNDING.yml Sponsorship configuration
docs/README.md User documentation index
docs/dev/RELEASE_HOTFIX.md Hotfix release process

2. Reorganize user documentation (docs/end-user/)

Moved all 20 end-user-facing markdown files from docs/ into docs/end-user/ to separate them from developer docs, i18n files, and assets. All internal links and image paths updated accordingly.

3. Consolidate images into docs/assets/

Moved all images from docs/ root and docs/dev/assets/ into the single docs/assets/ directory. All references updated across 13 files.

4. Modernize GitHub issue and PR templates

  • Replace bug_report.md with a structured Issue Form (bug_report.yml): required fields, OS dropdown, version inputs, auto-labels bug + triage
  • Improve feature_request.md: add [Feature] title prefix, enhancement label, restructured sections
  • Add config.yml: disable blank issues, add contact links to Discussions and Documentation
  • Remove legacy ISSUE_TEMPLATE.md (single-file, superseded by directory) and question.md (replaced by Discussions link)
  • Modernize PR template: Closes # link, type checklist, test plan section

5. i18n README alignment

Updated all i18n README files (README-{ar,de,es,fr,jp,kr,pt,tr,zh_cn,zh_tw}.md) to reflect the current root README structure and fix image/link paths.

Type of change

  • Bug fix (non-breaking, fixes an issue)
  • Documentation update

Test plan

  • Verify GitHub issue template selector shows Bug Report (form) + Feature Request + contact links to Discussions and Docs
  • Verify blank_issues_enabled: false hides the blank issue option
  • Verify all image paths in docs/ resolve correctly (no broken images)
  • Verify docs/README.md links correctly navigate to docs/end-user/ files
  • Verify CONTRIBUTING.md links to docs/dev/CODE_OF_CONDUCT.md correctly

Notes for reviewers


By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

…actor)

Restore 7 files that were unintentionally removed during the electron-vite
refactoring, which had no functional relation to the build system changes:

- .github/CHANGELOG.md        (858 lines, project history)
- .github/CODE_OF_CONDUCT.md  (74 lines, community guidelines)
- .github/PULL_REQUEST_TEMPLATE.md (16 lines, PR template)
- CONTRIBUTING.md             (92 lines, contribution guide)
- docs/README.md              (29 lines, user docs index)
- docs/dev/RELEASE_HOTFIX.md  (14 lines, hotfix release process)
- docs/i18n/tr.md             (265 lines, Turkish README, had no replacement)

Not restored: old i18n files replaced by renamed equivalents (README-fr.md
etc.), docs/i18n/pl.md (self-described as outdated since 2018), and test
data .md files whose entire test infrastructure was intentionally removed.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Copilot AI review requested due to automatic review settings May 13, 2026 05:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Restores documentation files that were unintentionally removed during the electron-vite refactor (PR #4001), bringing back GitHub/community metadata, contributor guidance, and user/developer docs.

Changes:

  • Restores GitHub community/metadata files (changelog, code of conduct, PR template).
  • Restores contributor and documentation index/process docs (CONTRIBUTING.md, docs/README.md, hotfix release doc).
  • Restores Turkish i18n documentation file.

Reviewed changes

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

Show a summary per file
File Description
.github/CHANGELOG.md Restores the project changelog in the .github area.
.github/CODE_OF_CONDUCT.md Restores the contributor code of conduct for community profile.
.github/PULL_REQUEST_TEMPLATE.md Restores the PR submission template used by GitHub.
CONTRIBUTING.md Restores the contributor guide and workflow expectations.
docs/README.md Restores the end-user documentation index page.
docs/dev/RELEASE_HOTFIX.md Restores instructions for preparing a hotfix release.
docs/i18n/tr.md Restores the Turkish documentation/readme translation.
Comments suppressed due to low confidence (3)

docs/i18n/tr.md:210

  • The CHANGELOG link uses .github/CHANGELOG.md, which resolves relative to docs/i18n/ and doesn’t exist. Update to the correct path (e.g. ../../.github/CHANGELOG.md) or an absolute GitHub URL.
| [![son sürüm](https://img.shields.io/github/downloads/marktext/marktext/latest/marktext-x64.dmg.svg)](https://github.com/marktext/marktext/releases/download/v0.17.1/marktext-x64.dmg) | [![son sürüm](https://img.shields.io/github/downloads/marktext/marktext/latest/marktext-setup.exe.svg)](https://github.com/marktext/marktext/releases/download/v0.17.1/marktext-setup.exe) | [![son sürüm](https://img.shields.io/github/downloads/marktext/marktext/latest/marktext-x86_64.AppImage.svg)](https://github.com/marktext/marktext/releases/download/v0.17.1/marktext-x86_64.AppImage) |

Son sürümde gelen değişiklikler için [CHANGELOG](.github/CHANGELOG.md)'a bakınız.

#### macOS

docs/i18n/tr.md:58

  • These links point to section anchors like #features and #download-and-installation, but the current root README uses different (numbered) headings, so these anchors don’t exist. Please update these URLs to match the current README headings/anchors.
    <a href="/api/browser/proxy?url=https%3A%2F%2Fgithub.com%2Fmarktext%2Fmarktext%23features">
      Özellikler
    </a>
    <span> | </span>
    <a href="/api/browser/proxy?url=https%3A%2F%2Fgithub.com%2Fmarktext%2Fmarktext%23download-and-installation">

docs/i18n/tr.md:77

  • The translation links here reference legacy filenames (e.g. zh_cn.md, zh_tw.md, etc.), but the repo now uses renamed equivalents like README-zh_cn.md, README-zh_tw.md, etc. These links will be broken unless updated to the new filenames.
  <sub>Çeviriler:</sub>
  <a href="zh_cn.md#readme">
    <span>:cn:</span>
  </a>
  <a href="zh_tw.md#readme">

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

Comment thread docs/README.md
Comment thread docs/i18n/README-tr.md Outdated
Comment thread .github/CONTRIBUTING.md
Jocs and others added 3 commits May 13, 2026 14:13
Move all 20 end-user-facing markdown files from docs/ into the new
docs/end-user/ subdirectory to separate them from developer docs,
i18n files, and static assets.

Update all affected links:
- docs/README.md: all local doc links now prefixed with end-user/
- docs/end-user/{BASICS,EDITING,EXPORT,SPELLING}.md: assets/ → ../assets/
- docs/end-user/THEMES.md: themeImages/ → ../themeImages/
- docs/i18n/README-{de,es,fr,jp,kr,pt,zh_cn,zh_tw}.md: ../THEMES.md → ../end-user/THEMES.md
- docs/i18n/tr.md: ../LINUX.md → ../end-user/LINUX.md
- docs/i18n/ar.md: ../../docs/LINUX.md → ../../docs/end-user/LINUX.md
- README.md: docs/THEMES.md → docs/end-user/THEMES.md

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Issue templates:
- Remove legacy single-file ISSUE_TEMPLATE.md (superseded by directory)
- Replace bug_report.md with structured Issue Form (bug_report.yml):
  required fields, OS dropdown, version inputs, reproducibility checkbox,
  auto-labels: bug + triage
- Improve feature_request.md: add title prefix "[Feature] ", label
  "enhancement", restructure sections (Summary / Problem / Proposed
  solution / Alternatives / Context)
- Remove question.md; questions now routed to GitHub Discussions
- Add config.yml: blank_issues_enabled=false, contact_links to
  Discussions and Documentation

PR template:
- Replace Q&A table with "Closes #" link + type checklist + test plan
- Add "Notes for reviewers" section
- Retain MIT license acknowledgement

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
… images

Move files:
- .github/CODE_OF_CONDUCT.md → docs/dev/CODE_OF_CONDUCT.md
- .github/CHANGELOG.md       → docs/CHANGELOG.md
- docs/{brew-cask.gif,doutu.jpg,focus.gif,marktext.png,source.gif,typewriter.gif}
                             → docs/assets/
- docs/dev/assets/marktext-interface.png → docs/assets/

Update all affected references (13 files):
- README.md: 4 image paths
- docs/i18n/README-{de,es,fr,jp,kr,pt,zh_cn,zh_tw}.md: 4 image paths each
- docs/i18n/tr.md: 4 image paths + CHANGELOG link
- docs/i18n/ar.md: 4 image paths + CHANGELOG link
- docs/dev/INTERFACE.md: marktext-interface.png path
- CONTRIBUTING.md: CODE_OF_CONDUCT.md link

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@Jocs
Jocs marked this pull request as draft May 13, 2026 06:36
Jocs and others added 5 commits May 13, 2026 14:45
- Move CONTRIBUTING.md → .github/CONTRIBUTING.md
- Rename docs/i18n/ar.md → docs/i18n/README-ar.md
- Rename docs/i18n/tr.md → docs/i18n/README-tr.md
- Remove docs/sponsor/ images (qordoba.png, readme.png)
- Update docs/end-user/BASICS.md and LINUX.md

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@Jocs
Jocs marked this pull request as ready for review May 13, 2026 07:46
@Jocs
Jocs requested a review from Copilot May 13, 2026 07:46
- Update .vscode/settings.json
- Update docs/dev/ARCHITECTURE.md
- Move docs/dev/code/IPC.md → docs/dev/IPC.md
- Remove docs/dev/code/ directory (BLOCK_ADDITION_PROPERTY.md, COMMANDS.md, IPC.md, README.md, renderer/editor.md)
- Remove docs/i18n-validation.md
- Update package.json

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@Jocs
Jocs merged commit 5e1f7e7 into develop May 13, 2026
@Jocs
Jocs deleted the fix/restore-deleted-docs branch May 13, 2026 07:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 40 out of 64 changed files in this pull request and generated 6 comments.

Comments suppressed due to low confidence (1)

.github/PULL_REQUEST_TEMPLATE.md:27

  • The [MIT license](LICENSE) link is broken here because this template is in .github/ (it resolves to .github/LICENSE). Use ../LICENSE or an absolute link so the license link works when rendered on GitHub.
---
By submitting this pull request, I confirm that my contribution is made under the terms of the [MIT license](LICENSE).

Comment thread .github/CONTRIBUTING.md
Comment on lines +5 to +13
- [Code of Conduct](docs/dev/CODE_OF_CONDUCT.md)
- [Philosophy](#philosophy)
- [Issue reporting guidelines](#issue-reporting-guidelines)
- [Pull request guidelines](#pull-request-guidelines)
- [Where should I start?](#where-should-i-start)
- [Quick start](#quick-start)
- [Build instructions](#build-instructions)
- [Style guide](#style-guide)
- [Developer documentation](#developer-documentation)
Comment thread .github/CONTRIBUTING.md

## Issue Reporting Guidelines

Please search for similar issues before opening an issue and always follow the [issue template](.github/ISSUE_TEMPLATE/). Please review the following Pull Request guidelines before making your own PR.
Comment thread .github/CONTRIBUTING.md
Comment on lines +77 to +80
### Build Instructions

🔗 [Build Instructions](docs/dev/BUILD.md)

Comment thread .github/CONTRIBUTING.md

## Developer Documentation

Please [click here](docs/dev/README.md) for more details.
Comment thread docs/README.md
Comment on lines +20 to +22
- [Export a document](end-user/EXPORT.md)
- [Image uploader configuration](end-user/IMAGE_UPLOADER_CONFIGRATION.md)
- [Installation instructions](../README.md#download-and-installation)
Comment thread README.md
Comment on lines 1 to +20
<p align="center"><img src="static/logo-small.png" alt="MarkText" width="100" height="100"></p>

<h1 align="center">MarkText</h1>

<div align="center">
Translations also available in:
<a href="docs/i18n/README-zh_cn.md">CN</a>
<a href="docs/i18n/README-zh_tw.md">TW</a>
<a href="docs/i18n/README-de.md">DE</a>
<a href="docs/i18n/README-es.md">ES</a>
<a href="docs/i18n/README-fr.md">FR</a>
<a href="docs/i18n/README-jp.md">JP</a>
<a href="docs/i18n/README-kr.md">KR</a>
<a href="docs/i18n/README-pt.md">PT</a>
<a href="https://twitter.com/intent/tweet?via=marktextme&url=https://github.com/marktext/marktext/&text=What%20do%20you%20want%20to%20say%20to%20app?&hashtags=happyMarkText">
<img src="https://img.shields.io/twitter/url/https/github.com/marktext/marktext.svg?style=for-the-badge" alt="twitter">
</a>
</div>

---

<div align="center">
<strong>🔆 Next generation markdown editor 🌙</strong><br>
<strong>:high_brightness: Next generation markdown editor :crescent_moon:</strong><br>
A simple and elegant open-source markdown editor that focused on speed and usability.<br>
<sub>Available for Linux, macOS and Windows.</sub>
</div>

<br>

<div align="center">
<!-- Latest Release Version -->
<a href="https://github.com/marktext/marktext/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/marktext/marktext">
<!-- License -->
<a href="LICENSE">
thimbleberrysystems pushed a commit to thimbleberrysystems/WordBird that referenced this pull request Jun 21, 2026
…vite refactor) (marktext#4196)

* fix: restore docs accidentally deleted in PR marktext#4001 (electron-vite refactor)

Restore 7 files that were unintentionally removed during the electron-vite
refactoring, which had no functional relation to the build system changes:

- .github/CHANGELOG.md        (858 lines, project history)
- .github/CODE_OF_CONDUCT.md  (74 lines, community guidelines)
- .github/PULL_REQUEST_TEMPLATE.md (16 lines, PR template)
- CONTRIBUTING.md             (92 lines, contribution guide)
- docs/README.md              (29 lines, user docs index)
- docs/dev/RELEASE_HOTFIX.md  (14 lines, hotfix release process)
- docs/i18n/tr.md             (265 lines, Turkish README, had no replacement)

Not restored: old i18n files replaced by renamed equivalents (README-fr.md
etc.), docs/i18n/pl.md (self-described as outdated since 2018), and test
data .md files whose entire test infrastructure was intentionally removed.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* refactor(docs): move user documentation into docs/end-user/

Move all 20 end-user-facing markdown files from docs/ into the new
docs/end-user/ subdirectory to separate them from developer docs,
i18n files, and static assets.

Update all affected links:
- docs/README.md: all local doc links now prefixed with end-user/
- docs/end-user/{BASICS,EDITING,EXPORT,SPELLING}.md: assets/ → ../assets/
- docs/end-user/THEMES.md: themeImages/ → ../themeImages/
- docs/i18n/README-{de,es,fr,jp,kr,pt,zh_cn,zh_tw}.md: ../THEMES.md → ../end-user/THEMES.md
- docs/i18n/tr.md: ../LINUX.md → ../end-user/LINUX.md
- docs/i18n/ar.md: ../../docs/LINUX.md → ../../docs/end-user/LINUX.md
- README.md: docs/THEMES.md → docs/end-user/THEMES.md

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* chore(github): modernize issue and PR templates

Issue templates:
- Remove legacy single-file ISSUE_TEMPLATE.md (superseded by directory)
- Replace bug_report.md with structured Issue Form (bug_report.yml):
  required fields, OS dropdown, version inputs, reproducibility checkbox,
  auto-labels: bug + triage
- Improve feature_request.md: add title prefix "[Feature] ", label
  "enhancement", restructure sections (Summary / Problem / Proposed
  solution / Alternatives / Context)
- Remove question.md; questions now routed to GitHub Discussions
- Add config.yml: blank_issues_enabled=false, contact_links to
  Discussions and Documentation

PR template:
- Replace Q&A table with "Closes #" link + type checklist + test plan
- Add "Notes for reviewers" section
- Retain MIT license acknowledgement

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* refactor(docs): reorganize CODE_OF_CONDUCT, CHANGELOG and consolidate images

Move files:
- .github/CODE_OF_CONDUCT.md → docs/dev/CODE_OF_CONDUCT.md
- .github/CHANGELOG.md       → docs/CHANGELOG.md
- docs/{brew-cask.gif,doutu.jpg,focus.gif,marktext.png,source.gif,typewriter.gif}
                             → docs/assets/
- docs/dev/assets/marktext-interface.png → docs/assets/

Update all affected references (13 files):
- README.md: 4 image paths
- docs/i18n/README-{de,es,fr,jp,kr,pt,zh_cn,zh_tw}.md: 4 image paths each
- docs/i18n/tr.md: 4 image paths + CHANGELOG link
- docs/i18n/ar.md: 4 image paths + CHANGELOG link
- docs/dev/INTERFACE.md: marktext-interface.png path
- CONTRIBUTING.md: CODE_OF_CONDUCT.md link

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* revert: restore root README.md to master branch version

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* fix: correct broken links in README.md

* chore: miscellaneous file reorganization

- Move CONTRIBUTING.md → .github/CONTRIBUTING.md
- Rename docs/i18n/ar.md → docs/i18n/README-ar.md
- Rename docs/i18n/tr.md → docs/i18n/README-tr.md
- Remove docs/sponsor/ images (qordoba.png, readme.png)
- Update docs/end-user/BASICS.md and LINUX.md

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* fix: restore .github/FUNDING.yml from master

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* feat(i18n): re-translate all README files from root README.md source

* chore: misc dev docs and config updates

- Update .vscode/settings.json
- Update docs/dev/ARCHITECTURE.md
- Move docs/dev/code/IPC.md → docs/dev/IPC.md
- Remove docs/dev/code/ directory (BLOCK_ADDITION_PROPERTY.md, COMMANDS.md, IPC.md, README.md, renderer/editor.md)
- Remove docs/i18n-validation.md
- Update package.json

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

---------

Co-authored-by: Claude Sonnet 4.6 <[email protected]>
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