Skip to content
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

docs(examples) Add table and improve design #3688

Merged
merged 70 commits into from
Jul 1, 2024

Conversation

charlesbvll
Copy link
Member

@charlesbvll charlesbvll commented Jun 28, 2024

Issue

Description

Currently the Flower Examples doc page is just an organized list of pages, without any description what so ever:

image

Related issues/PRs

N/A

Proposal

Explanation

  • Use Python instead of Bash
  • Add intro/description of what Flower Examples are
  • Use a table to display the list of pages
  • Separate the examples into quickstart, advanced, and others

image

Checklist

  • Implement proposed change
  • Update documentation
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Any other comments?

N/A

@charlesbvll charlesbvll marked this pull request as ready for review June 30, 2024 14:49
index_file.write(
"Flower Examples are a collection of example projects written with "
"Flower that explore different domains and features. You can check "
"which examples already exist and/or contribute your own example.\n"
Copy link
Contributor

Choose a reason for hiding this comment

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

should we add a link to the "contribute your own example" text pointing to our contributors guide?

@danieljanes danieljanes merged commit d87b737 into main Jul 1, 2024
29 checks passed
@danieljanes danieljanes deleted the improve-example-docs-script branch July 1, 2024 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants