docs: apply KISS principles to simplify documentation #27
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
- Streamline CONTRIBUTING.md from detailed installation to quick start commands - Reference README for full development instructions to avoid duplication - Add simple Development section to README with essential pip install workflow - Maintain comprehensive version anchors documentation for existing functionality - Follow progressive disclosure: basic usage first, advanced options clearly marked - Remove redundant explanations while preserving all necessary information
|
|
||
| The conda-sphinx-theme is a community maintained project. We welcome contributions in the form of bug reports, | ||
| documentation, code, design proposals, and more. | ||
| We welcome contributions! Please see the [Development and Testing](README.md#development-and-testing) section in the README for setup instructions. |
There was a problem hiding this comment.
Looks like the anchor is just #development, unless I'm missing something.
|
This'll need an update when #25 lands |
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.
Apply KISS (Keep It Simple, Stupid) principles to documentation. Streamline README and CONTRIBUTING for better developer experience.
Depends on #23
Xref #24
Xref #25
Xref #26