Update documentation to make it easier for firstcomers#1310
Merged
Conversation
Member
Author
|
One comment is to streamline the docker image naming, which is pretty confusing. We could use
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR aims to improve the documentation user experience by making it less intimidating for Python and new developers. The changes focus on providing better getting started guidance, cloud deployment options, and prioritizing Docker over native installation.
- Modernizes the documentation theme from ReadTheDocs to Material Design for better user experience
- Creates a comprehensive "Getting Started" guide that prioritizes cloud and Docker deployment options
- Reorganizes navigation structure to put essential information first and deprecate advanced features
Reviewed Changes
Copilot reviewed 23 out of 29 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
readthedocs.yml |
Updates build environment to Ubuntu 24.04 |
mkdocs.yml |
Switches theme to Material Design with dark/light mode and reorganizes navigation |
doc/requirements.txt |
Adds mkdocs-material dependency |
doc/readthedocs.js |
Adds JavaScript for ReadTheDocs integration with Material theme |
doc/overrides/main.html |
Adds template override for ReadTheDocs API integration |
doc/getting_started.md |
Creates new comprehensive getting started guide |
doc/index.md |
Updates main page structure and navigation links |
| Multiple training docs | Converts note blocks to Material Design admonitions |
| Various service docs | Updates references and adds error handling documentation |
Readme.md |
Updates demo link and adds getting started tip |
| GitHub workflows | Updates Docker image tagging conventions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
+1
to
+7
| document.addEventListener("DOMContentLoaded", function(event) { | ||
| // Trigger Read the Docs' search addon instead of Material MkDocs default | ||
| document.querySelector(".md-search__input").addEventListener("focus", (e) => { | ||
| const event = new CustomEvent("readthedocs-search-show"); | ||
| document.dispatchEvent(event); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Variable name collision: The parameter event in the outer function shadows the locally created event CustomEvent. This could cause confusion and potential issues. Consider renaming one of the variables.
Merged
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.
This PR aims to make the documentation less scary for python and young developers 🐉
Goals: