CRAVEX-Docs: Improve docs for Getting Started purposes#202
Merged
DennisClark merged 22 commits intomainfrom Jan 5, 2026
Merged
CRAVEX-Docs: Improve docs for Getting Started purposes#202DennisClark merged 22 commits intomainfrom
DennisClark merged 22 commits intomainfrom
Conversation
Add additional project descriptions and getting started items.
tsteenbe
requested changes
Jul 1, 2025
tsteenbe
left a comment
tsteenbe
left a comment
There was a problem hiding this comment.
@DennisClark Good start but I not sure if these are getting started guides - getting started pages are meant to help users get up and running as quickly as possible. The smell like more like tutorials with the amount of detailed instructions. What can we do to simplify the number of steps / make it simpler stories?
docs/source/getting-started/temp.rst
Outdated
There was a problem hiding this comment.
Why are you adding these "deprecated" lines in these files?
Member
Author
|
@tsteenbe thanks for the comments. The extra files are there by mistake and I need some technical help to get rid of them, that's all. |
chinyeungli
reviewed
Jul 2, 2025
chinyeungli
requested changes
Jul 2, 2025
DennisClark
moved this to In Progress
in 03-AboutDoc: better docs to get started and beyond
pombredanne
changed the title
github-project-automation
bot
moved this from In progress
to Done
in 00-AboutCodePlanner
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
4 participants
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.
Addresses this issue:
CRAVEX-Docs: Improve documentation www.aboutcode.org#27
Added a getting-started folder and new docs.
Added two projects to the aboutcode-projects folder.
Modified the aboutcode-project-overview doc.