Skip to content

docs: simplify roadmap text #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 30, 2025
Merged

docs: simplify roadmap text #339

merged 6 commits into from
May 30, 2025

Conversation

signekb
Copy link
Member

@signekb signekb commented May 27, 2025

Description

This PR needs a quick review.

Checklist

  • Formatted Markdown
  • Ran just run-all

@lwjohnst86 lwjohnst86 moved this from Todo to In Review in Iteration planning May 27, 2025
Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

Only one main comment ☺️

@@ -167,14 +149,14 @@ products are all classified as "ongoing".

| Status | Information resource |
|:--------------------------------------------:|:-------------------------|
| {{< var status.ongoing >}} | [`seedcase-project/reference`](https://sprout.seedcase-project.org/docs/reference/): Reference docs for Sprout. |
Copy link
Member

Choose a reason for hiding this comment

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

I think including each guide, explanation, and reference page for each software is overkill here. Instead we could state in the starting section of the doc section that each software has or will aim to have each of diataxis sections.

Plus, the repo would be seedcase-project/seedcase-sprout, not reference

Copy link
Member Author

@signekb signekb May 28, 2025

Choose a reason for hiding this comment

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

Yeah, maybe you're right. I thought it was deliberate to very explicitly show the work that goes into that.
But I'll add a text and remove it here 👍

Copy link
Member

Choose a reason for hiding this comment

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

Though I guess we do have the link to the guides above. If you match the text for that here, for the reference docs, that would be fine with me 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

If I understood you correctly here, it was fine to just fix the link above but keep it?

@github-project-automation github-project-automation bot moved this from In Review to In Progress in Iteration planning May 27, 2025
@signekb signekb requested a review from lwjohnst86 May 30, 2025 08:08
@github-project-automation github-project-automation bot moved this from In Progress to In Review in Iteration planning May 30, 2025
@lwjohnst86 lwjohnst86 merged commit 8ac454b into main May 30, 2025
1 check was pending
@lwjohnst86 lwjohnst86 deleted the docs/simplify-roadmap-text branch May 30, 2025 08:13
@github-project-automation github-project-automation bot moved this from In Review to Done in Iteration planning May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants