Skip to content

CRAVEX-Docs: Improve docs for Getting Started purposes - #202

Merged
DennisClark merged 22 commits into
mainfrom
improve-docs
Jan 5, 2026
Merged

CRAVEX-Docs: Improve docs for Getting Started purposes#202
DennisClark merged 22 commits into
mainfrom
improve-docs

Conversation

@DennisClark

@DennisClarkDennisClark commented Jun 30, 2025•
edited by pombredanne
Loading

Copy link
Copy Markdown
Member

Addresses this issue:

@DennisClarkDennisClark mentioned this pull request Jun 30, 2025
Open
tsteenbe
tsteenbe suggested changes Jul 1, 2025
View reviewed changes

@tsteenbetsteenbe left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Comment threaddocs/source/getting-started/consume-sboms.rst Outdated
Comment threaddocs/source/getting-started/create-sboms.rst Outdated
Comment threaddocs/source/getting-started/consume-sboms.rst
Comment threaddocs/source/getting-started/temp.rst Outdated

@tsteenbetsteenbeJul 1, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you adding these "deprecated" lines in these files?

@DennisClarkDennisClarkJul 7, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

@DennisClark

DennisClark commented Jul 1, 2025

Copy link
Copy Markdown
MemberAuthor

@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
chinyeungli reviewed Jul 2, 2025
View reviewed changes
Comment threaddocs/source/aboutcode-project-overview.rst
chinyeungli
chinyeungli requested changes Jul 2, 2025
View reviewed changes
Comment threaddocs/source/aboutcode-projects/dejacode-project.rst Outdated
Comment threaddocs/source/getting-started/manage-license-policies.rst Outdated
@DennisClarkDennisClark self-assigned this Jul 2, 2025
@pombredannepombredanne moved this to In progress in 00-AboutCodePlannerJul 22, 2025
@pombredannepombredanne mentioned this pull request Dec 2, 2025
Closed
@pombredannepombredanne changed the title Improve docs for Getting Started purposesCRAVEX-Docs: Improve docs for Getting Started purposesDec 2, 2025
@DennisClark
DennisClark merged commit 518cf1f into mainJan 5, 2026
@github-project-automationgithub-project-automationBot moved this from In progress to Done in 00-AboutCodePlannerJan 5, 2026
@pombredannepombredanne moved this from Done to Validated in 00-AboutCodePlannerJan 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chinyeunglichinyeunglichinyeungli requested changes
@pombredannepombredanneAwaiting requested review from pombredanne
@mjherzogmjherzogAwaiting requested review from mjherzog
+1 more reviewer
@tsteenbetsteenbetsteenbe requested changes
Reviewers whose approvals may not affect merge requirements

Assignees

@DennisClarkDennisClark

Labels

about-docs-b6

Projects

00-AboutCodePlanner
Status: Validated
03-AboutDoc: better docs to get started and beyond
Status: In progress

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@DennisClark@tsteenbe@chinyeungli@pombredanne