FIX: Documentation#7118
Merged
Merged
Conversation
Updated anc cleaned up documents
Contributor
There was a problem hiding this comment.
Pull Request Overview
The purpose of this PR is to clean up the documentation by removing outdated archive files, converting several .txt documents to markdown (.md), and updating HTML files to use modern, well‐formed markup. Key changes include:
- Removal of legacy and archive documentation files (e.g. in the Archive Stuff folder, planets.txt, plugins.txt).
- Conversion of multiple documentation files from .txt to .md (e.g. custom_spa, advanced_medical_overview, SarnaCartographyImport, Stratcon_Tips).
- Updates to HTML documentation files (UserDirHelp.html, Scenario Template Editor.html) that add DOCTYPE declarations and improve formatting.
Reviewed Changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| MekHQ/docs/scenariomodifiers.md | New markdown documentation for scenario modifiers. |
| MekHQ/docs/plugins.txt | Removed legacy MekHQ plugin guide. |
| MekHQ/docs/planets.txt | Removed old planets documentation. |
| MekHQ/docs/custom_spa.txt | Removed legacy .txt version of custom SPA documentation. |
| MekHQ/docs/custom_spa.md | New markdown version of custom SPA documentation. |
| MekHQ/docs/advanced_medical_overview.txt | Removed legacy advanced medical overview in .txt format. |
| MekHQ/docs/advanced_medical_overview.md | New markdown version for advanced medical overview. |
| MekHQ/docs/UserDirHelp.html | Updated HTML for proper DOCTYPE, language, and improved formatting. |
| MekHQ/docs/StratCon/stratcon-faq-2.6.txt | Removed outdated StratCon FAQ. |
| MekHQ/docs/StratCon/Stratcon_Tips.txt | Removed legacy StratCon tips in .txt. |
| MekHQ/docs/StratCon/Stratcon_Tips.md | New markdown version of StratCon tips. |
| MekHQ/docs/Scenario Template Editor.html | Upgraded HTML markup with DOCTYPE and enhanced readability. |
| MekHQ/docs/SarnaCartographyImport.txt | Removed legacy Sarna Cartography import instructions in .txt format. |
| MekHQ/docs/SarnaCartographyImport.md | New markdown version of Sarna Cartography import instructions. |
| MekHQ/docs/Archive Stuff/* | Removed several outdated archive files. |
| MekHQ/data/universe/defaultspa.xml | Minor update in comments: changed reference from docs/custom_spa.txt to docs/custom_spa.md. |
| MekHQ/data/universe/customspa.xml | Minor update in comments: changed reference from docs/custom_spa.txt to docs/custom_spa.md. |
Comments suppressed due to low confidence (1)
MekHQ/data/universe/defaultspa.xml:1254
- Ensure all internal documentation references for the custom SPA guidelines have been updated consistently to use the .md files rather than legacy .txt files.
<!-- See docs/custom_spa.md
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7118 +/- ##
=========================================
Coverage 12.46% 12.46%
- Complexity 7354 7355 +1
=========================================
Files 1137 1137
Lines 146336 146336
Branches 22441 22441
=========================================
Hits 18238 18238
- Misses 126219 126221 +2
+ Partials 1879 1877 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Removed archive documents.
Converted txt -> md
cleaned up HTML.