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

Refresh project status in README and website homepage. #19482

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

ScottTodd
Copy link
Member

@ScottTodd ScottTodd commented Dec 13, 2024

  • Replace "IREE is still in its early phase." language with information about IREE being a sandbox project at the LF AI & Data Foundation.
  • Link to release notes via the non-prerelease releases page since the standard https://github.com/iree-org/iree/releases page is littered with nightly releases. Grouping prereleases under a single release like in iree-turbine and other projects would help here too.
  • Format "Presentations and talks" section with a table. We've had a few talks that aren't yet included here and the community meetings are now split between YouTube and Zoom (LF AI) ... not sure how best to organize them.
  • Add more icons to https://iree.dev/ homepage and expand on sections:
    image

@ScottTodd ScottTodd added the documentation ✏️ Improvements or additions to documentation label Dec 13, 2024
@ScottTodd ScottTodd requested a review from marbre December 13, 2024 19:52
Copy link
Member

@marbre marbre left a comment

Choose a reason for hiding this comment

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

Nice! Just a few comments but nothing that prevents merging as is.

Comment on lines +18 to +19
All stable (non-prerelease) releases can be viewed at
<https://github.com/iree-org/iree/releases?q=prerelease%3Afalse>.
Copy link
Member

@marbre marbre Dec 16, 2024

Choose a reason for hiding this comment

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

Suggested change
All stable (non-prerelease) releases can be viewed at
<https://github.com/iree-org/iree/releases?q=prerelease%3Afalse>.
All stable (non-prerelease) releases can be viewed at GitHub
[releases page](https://github.com/iree-org/iree/releases?q=prerelease%3Afalse).

?.

Copy link
Member Author

Choose a reason for hiding this comment

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

(fixed the suggestion syntax in your comment)

For this developer page I want to spell out the URL, query parameters and all. In the README I have it hidden under some nicer text:

### Release status

Releases notes are
[published on GitHub releases](https://github.com/iree-org/iree/releases?q=prerelease%3Afalse).

If we switch this repo to using a "dev-wheels" style release for multiple nightly releases to append assets to then we can switch both back to the base https://github.com/iree-org/iree/releases, since the daily pre-releases won't be spammed

@@ -159,7 +159,7 @@ runtime entirely or interface with custom accelerators.
IREE supports the full set of these configurations using the same underlying
technology.

### Compiling models
### :octicons-file-code-24: Compiling models
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this should get :octicons-rocket-24: 🚀 😉

Copy link
Member Author

Choose a reason for hiding this comment

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

was going for consistency with these

### :octicons-file-code-16: Compile a program
### :octicons-file-code-16: Compile a program

(but with 24 instead of 16 on the homepage... I liked the 16px icons on subpages but 24px felt better here 🤷 https://primer.style/foundations/icons)

Copy link
Member Author

Choose a reason for hiding this comment

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

and the previous section uses the rocket icon already

Copy link
Member

Choose a reason for hiding this comment

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

Well this wasn't supposed to be a serious comment ;)

docs/website/docs/index.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ✏️ Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants