docs: standardise repo structure and file naming conventions - #59
Merged
Conversation
- Rename all .md files and apache-licence to PascalCase-Dash convention - Rename ADR-Index.md and MARS-Index.md to README.md in their directories - Add missing README.md to Legal/ and Principles/ directories - Update all 36 internal links across 13 files to match new filenames All 12 top-level subdirectories now have a README.md listing their contents.
There was a problem hiding this comment.
Pull request overview
This PR standardises documentation structure and naming across the repository by renaming Markdown documents, adding per-directory entrypoint READMEs, and updating internal links to match the new filenames.
Changes:
- Renamed documentation files to a PascalCase-with-dashes convention and updated references accordingly.
- Added/renamed directory entrypoint
README.mdfiles (e.g., for ADR and MARS language) and introduced new index READMEs forLegal/andPrinciples/. - Updated cross-document links so they resolve to the renamed files.
Reviewed changes
Copilot reviewed 15 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| TODO.md | Updates references to renamed docs (Versioning, Python Wheels, Repository Structure example, Apache licence file). |
| Software Management Plan/README.md | Updates Apache licence link to renamed Legal/Apache-Licence. |
| Repository Structure/Example.md | Adds a README template/example with badges and boilerplate sections. |
| README.md | Updates root contents link to renamed Code of Conduct document. |
| Principles/README.md | Adds a directory index README linking to renamed Principles docs. |
| Principles/Open-Source-Principles.md | Adds the renamed Open Source Principles document content. |
| Principles/Code-Of-Conduct.md | Updates links to the renamed Open Source Principles document. |
| MARS language/README.md | Renames/reworks the MARS index into a README with resources + index. |
| Legal/Requesting-New-Repository.md | Updates link to renamed Open Sourcing Software procedure doc. |
| Legal/README.md | Adds a directory index README for Legal docs and the Apache licence text. |
| Legal/Open-Sourcing-Software.md | Updates internal links to renamed Legal documents. |
| Legal/Copyright-And-Licensing.md | Updates link to renamed Apache-Licence file. |
| Legal/Contributor-License-Agreement.md | Adds the CLA text as a renamed/standardised doc. |
| Legal/Apache-Licence | Adds the Apache 2.0 licence text under the renamed filename. |
| Languages/Versioning.md | Adds the renamed Versioning placeholder document. |
| Languages/README.md | Updates links to renamed Python Wheels and Versioning docs. |
| Languages/Python-Wheels.md | Adds the renamed Python Wheels documentation content. |
| Guidelines/External-Contributions.md | Updates links to renamed Legal documents. |
| Contributing Upstream/README.md | Updates link to renamed Forking doc. |
| Contributing Upstream/Forking.md | Adds the renamed Forking guidance document content. |
| ADR/README.md | Renames/reworks the ADR index into a README with resources + index. |
| ADR/ADR-008-Stack-Dependencies.md | Updates references/links to the renamed Python Wheels doc. |
Comments suppressed due to low confidence (1)
Legal/Open-Sourcing-Software.md:38
- Typo: "prefered" should be "preferred".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
.mdfiles (andapache-licence) to PascalCase-Dash convention — 13 files renamedREADME.md— renamedADR-Index.md→README.mdandMARS-Index.md→README.md; created new READMEs forLegal/andPrinciples/Files renamed
ADR/ADR-Index.mdADR/README.mdMARS language/MARS-Index.mdMARS language/README.mdPrinciples/CODE_OF_CONDUCT.mdPrinciples/Code-Of-Conduct.mdPrinciples/open-source-principles.mdPrinciples/Open-Source-Principles.mdLegal/contributor_license_agreement.mdLegal/Contributor-License-Agreement.mdLegal/copyright_and_licensing.mdLegal/Copyright-And-Licensing.mdLegal/open_sourcing_software.mdLegal/Open-Sourcing-Software.mdLegal/requesting_new_repository.mdLegal/Requesting-New-Repository.mdLegal/apache-licenceLegal/Apache-LicenceLanguages/python_wheels.mdLanguages/Python-Wheels.mdLanguages/versioning.mdLanguages/Versioning.mdContributing Upstream/forking.mdContributing Upstream/Forking.mdRepository Structure/example.mdRepository Structure/Example.mdNew files
Legal/README.md— lists all Legal directory contentsPrinciples/README.md— lists all Principles directory contentsNot renamed
SVG badges, PNG images, and
.docxfiles were intentionally left unchanged per agreed scope.