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

Write an introduction section for the project #187

Open
schuylermartin45 opened this issue Oct 9, 2024 · 0 comments
Open

Write an introduction section for the project #187

schuylermartin45 opened this issue Oct 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request source::maintainer to sort Needs additional investigation

Comments

@schuylermartin45
Copy link
Collaborator

We need to add a better introduction section to our README.md and self-hosted docs page.

We should answer: why does this project exist? and how can it help me?

Here is some text we could adapt.

In order for us to improve our package building efforts, we need to automate our process. We have had many engineers (internally and in the community) attempt to automate parts of our process in the past. From those accounts and seeing some of those projects, I believe the core issue is our inability to semantically understand our own recipe format. The Conda Recipe Manager project addresses that issue by being the first tool in our community that can parse recipe files. That has enabled the development of a high-level API for retrieving and editing information in a recipe file.

With this library/API, we can rapidly accelerate the development of other automated tools. We no longer have to re-invent the wheel for every recipe format edge case. No longer do we have to write a series of regular expressions to read very specific portions of the file. If it parses, we can retrieve data from the and edit the file.

Simply put, this project enables others to do complex operations easily.
@schuylermartin45 schuylermartin45 added documentation Improvements or additions to documentation enhancement New feature or request source::maintainer to sort Needs additional investigation labels Oct 9, 2024
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 enhancement New feature or request source::maintainer to sort Needs additional investigation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant