Restructure readme and docs #20
Open
Conversation
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
link edited.
- The main README.md is now a concise introduction, directing you to `docs/index.md` for the full list of resources. - I've included an example of checkbox-based progress tracking in the main README.md. - I've added a placeholder section at the top of `docs/index.md` for incorporating recent updates. - `docs/index.md` is now designated as the primary content file, as reflected in the MkDocs configuration. Note: I encountered persistent technical issues when trying to automatically format `docs/index.md` with checkboxes for all items and could not complete that. The file remains largely in its original format but is now clearly marked as the main resource collection.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.