docs(doc-15): add descriptions to Kittehub project table #42
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daabr
approved these changes
Aug 9, 2024
daabr
approved these changes
Aug 9, 2024
pashafateev
added a commit
that referenced
this pull request
Sep 3, 2024
I don’t think adding an additional column for features is necessary. Here are some thoughts: from [doc-13](https://linear.app/autokitteh/issue/DOC-13/readmemd-for-kittehub-index-table-showing-what-each-project-does) >start various connection types, `@autokitteh.activity`, subscribe & next_event, python vs starlark, maybe you can think of a few more. - **`@autokitteh.activity`:** If we’re trying to minimize the use of `autokitteh.activity`, it doesn’t make sense to highlight it, especially since it's not a concept most users will immediately understand. - **`subscribe` and `next_event`:** As far as I know, these features aren’t present in Kittehub. - **Python vs Starlark:** If it's important to distinguish between Python and Starlark implementations, I suggest using an emoji with a legend for clarity. For example: ## Legend: ⭐️ - Implemented in Starlark 🐍 - Implemented in Python ... | 🐍 [Data Pipeline](./data_pipeline/) | | ⭐️ [GitHub Copilot Seats](./github_copilot/) | | 🐍 [Google Forms to Jira](./google_forms_to_jira/) | | 🐍 [Jira Assignee From Calendar](./jira_assignee_from_calendar/) | | 🐍 [Jira to Google Calendar](./jira_to_google_calendar/) | | ⭐️ [Pull Request Review Reminder (Purrr)](./purrr/) | | ⭐️ [ReviewKitteh](./reviewkitteh/) | | 🐍 [Task Chain](./task_chain/) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don’t think adding an additional column for features is necessary.
Here are some thoughts:
from doc-13
@autokitteh.activity: If we’re trying to minimize the use ofautokitteh.activity, it doesn’t make sense to highlight it, especially since it's not a concept most users will immediately understand.subscribeandnext_event: As far as I know, these features aren’t present in Kittehub.Python vs Starlark: If it's important to distinguish between Python and Starlark implementations, I suggest using an emoji with a legend for clarity. For example:
Legend:
⭐️ - Implemented in Starlark
🐍 - Implemented in Python
...
| 🐍 Data Pipeline |
| ⭐️ GitHub Copilot Seats |
| 🐍 Google Forms to Jira |
| 🐍 Jira Assignee From Calendar |
| 🐍 Jira to Google Calendar |
| ⭐️ Pull Request Review Reminder (Purrr) |
| ⭐️ ReviewKitteh |
| 🐍 Task Chain |