In conversations with @aaronjridley, we decided a good use of time would be to lay out the .md files a little better. This has been done and is described along with each commit.
In essence, the collection of markdown files at the root of the repository and within doc/ were repetitive and poorly referenced. I have rearranged a lot of the content (taking care to not remove anything), and added a table-of-contents and file tree (to show which files are available) where it made sense to.
Additionally, this PR changes a lot of the markdown formatting be consistent across all files. This includes headers in descending order, no double-blank lines, consistent use of dashes/equals or hashtags for headers within the same file, etc. Some typos fixed as well. No breaking changes, no fundamental changes to the content. Just a little cleaner to read, edit, and browse.
All files pass markdown linting, except the PR template... .github/bug_report.md was edited to change the example OS from iOS to MacOS/Linux. PR template untouched for the sake of consistency.
The final commit in this PR (5c984fe79), however, does alter the default aether.json file in order to enable the tests to run successfully. I changed this file to include specifications for the ionGrid. These changes do not need to be accepted, and the commit can be removed from the PR if a fix to the problem is in the works already.
Type of change
Please delete options that are not relevant.
Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
This change requires a documentation update
The documentation has been updated.
How Has This Been Tested?
Docs' formatting enforced with markdownlint within its VSCode extension.
Default aether.json tested by running Aether locally and also by watching the automated test run.
Test configuration
Operating system: MacOS, Ubuntu (GitHub test workflow)
Compiler, version number: clang (15.0.0), gcc (workflow default)
Any details about your local setup that are relevant
Checklist:
[N/A] Make sure you are merging into the develop (not master) branch
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
[N/A] Add a note to CHANGELOG.md, summarizing the changes
Description
Addresses:
In conversations with @aaronjridley, we decided a good use of time would be to lay out the
.mdfiles a little better. This has been done and is described along with each commit.In essence, the collection of markdown files at the root of the repository and within doc/ were repetitive and poorly referenced. I have rearranged a lot of the content (taking care to not remove anything), and added a table-of-contents and file tree (to show which files are available) where it made sense to.
Additionally, this PR changes a lot of the markdown formatting be consistent across all files. This includes headers in descending order, no double-blank lines, consistent use of dashes/equals or hashtags for headers within the same file, etc. Some typos fixed as well. No breaking changes, no fundamental changes to the content. Just a little cleaner to read, edit, and browse.
All files pass markdown linting, except the PR template... .github/bug_report.md was edited to change the example OS from iOS to MacOS/Linux. PR template untouched for the sake of consistency.
The final commit in this PR (5c984fe79), however, does alter the default
aether.jsonfile in order to enable the tests to run successfully. I changed this file to include specifications for theionGrid. These changes do not need to be accepted, and the commit can be removed from the PR if a fix to the problem is in the works already.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Docs' formatting enforced with markdownlint within its VSCode extension.
Default
aether.jsontested by running Aether locally and also by watching the automated test run.Test configuration
Checklist:
develop(notmaster) branchCHANGELOG.md, summarizing the changes