(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)
Currently there's an error building the documentation website (see https://github.com/david-yz-liu/memory-viz/actions/runs/9201374627/job/25309470894). This is due to a broken link in the project README being used under the api subpath in the documentation folder. However, this page shouldn't actually exist, since the README contents are already present on the documentation homepage.
So, this change just removes the README from the API documentation section.
Screenshots of your changes (if applicable)
Type of Change
(Write an X or a brief description next to the type or types that best describe your changes.)
Type
Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
X
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)
Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)
Before opening your pull request:
[x] I have performed a self-review of my changes.
Check that all changed files included in this pull request are intentional changes.
Check that all changes are relevant to the purpose of this pull request, as described above.
[x] I have added tests for my changes, if applicable.
This is required for all bug fixes and new features.
[x] I have updated the project documentation, if applicable.
This is required for new features.
[x] If this is my first contribution, I have added myself to the list of contributors.
[x] I have updated the project Changelog (this is required for all changes).
After opening your pull request:
[x] I have verified that the CI tests have passed.
[x] I have reviewed the test coverage changes reported by Coveralls.
Proposed Changes
(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)
Currently there's an error building the documentation website (see https://github.com/david-yz-liu/memory-viz/actions/runs/9201374627/job/25309470894). This is due to a broken link in the project README being used under the
api
subpath in the documentation folder. However, this page shouldn't actually exist, since the README contents are already present on the documentation homepage.So, this change just removes the README from the API documentation section.
Screenshots of your changes (if applicable)
Type of Change
(Write an
X
or a brief description next to the type or types that best describe your changes.)Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the
[ ]
into a[x]
in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)Before opening your pull request:
After opening your pull request:
Questions and Comments
(Include any questions or comments you have regarding your changes.)