-
Notifications
You must be signed in to change notification settings - Fork 45
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
Document where we are so far. #1
Comments
We could perhaps create a file such as Some topics and questions I've seen come up so far:
I think it's best to present everything as a discussion of the various options (as opposed to "choosing" what we think are the best trade offs to make, since everyone will ultimately disagree). Edit: We can discuss more general project direction stuff here. See #4 for more about concerns/approaches. |
I think it would be a good idea to list (mostly) everything we have so far and try to categorize it and try to look what background the project has. But i don't know really how to start. Should me make one tracking issue and several others for every one to discuss it? I have a list with some projects worth looking at https://github.com/pythoneer/areweguiyet/wiki but i think we need to dig in there as a starting point. |
Your list is excellent! I think an issue for each item is reasonable, so that it is easy to follow discussions. We can create issues as we work through them. I would like to make the CLI interactive so that anyone can quickly create a PR to add a crate. I think for each crate, this is what I am currently thinking we should collect:
Let me know if there's more we should do or if I forgot anything! What I would like to add to the "crate cards" on the web page:
For the things I mentioned in my first post in this issue (I'll add an edit): things that are not about specific crates I think will go in an "approaches" section, to be designed/built. I'll create a separate issue for that and we can discuss how and if we still want to do that. |
This sounds great. I would start to process the list and turn it into issues. I am just wondering how to effectively collect a "result". I could imagine two ways that would depend on how to actually create an end result on the page. The main problem with collecting stuff inside the issue is that the information gets scattered across multiple post inside of it. So either we have a wiki page for each issue in which we constantly collect and update information as we go and turn it into content for the webpage if we feel confident. The other way would just start out corresponding PR's. I think creating PR's is the appropriate way. So that leads me to the question how do i actually crate content? How far is your tool or should we start by manually crate content to start. What exactly do i have to do to make this happen. I glimpsed over the website code and i would guess the EDIT: Forgot to mention. The reason i mentioned wiki pages is because the current state of json does not reflect all the information you i and want to be inside of it for each crate. I agree with the points you listed above and i think they will change over time as we go but this looks like a good starting point. But that is a point that speaks against PR's and start with wiki pages until we have the infrastructure to represent all the information we like. |
The tool is not very far along. I will try to improve it a little more this week, hopefully. There are a few crates that should help with making CLIs, and I would like to try them out. I think in addition to what is there already, below are some examples of how we can extend {
name: String,
description: Option<String>,
docs: Option<String>,
repo: Option<String>,
tags: Vec<String>,
// new stuff:
// We may want to enforce that these follow some kind of pattern, i.e, official links only for each
// chat platform, like discord.gg for Discord, for instance
chats: Vec<String>,
// A paragraph that appears in the card following the crates.io description
// (will get cut off if it is too long, and there will be a "read more" button)
extended_description: Vec<String>,
// use cases described in bullet points
use_cases: Vec<String>,
// these will become a list of bullet points
pros: Vec<String>,
cons: Vec<String>,
// see my earlier post for what this enum could support
status: ProjectStatus,
last_updated: String,
}
I agree that information will get scattered in issues. PRs should work well, since the |
A number of potential approaches to GUI, potential problems and potential solutions have been raised in discussion. Those need to be documented for reference.
The text was updated successfully, but these errors were encountered: