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

Shorten overlong project descriptions #181

Open
theodore-s-beers opened this issue Nov 23, 2022 · 2 comments
Open

Shorten overlong project descriptions #181

theodore-s-beers opened this issue Nov 23, 2022 · 2 comments
Assignees

Comments

@theodore-s-beers
Copy link
Collaborator

Some project descriptions are on the long side, in my opinion. It's not great for the website.

I found two outlier projects that had descriptions that were over 800 characters, and shortened both of them substantially—without really getting rid of important information.

@XeniaMonika, this might be something that you could look into. There are still 11 projects with descriptions over 700 characters. I think, somewhat subjectively, that we should at least be able to set an upper limit of 600. Perhaps that could even be enforced in the schema. Let me know what you think.

@XeniaMonika
Copy link
Collaborator

Ok, have a standard for it wouldn´t be bad! I also agree that it looks better on the website. I can rewrite them

@theodore-s-beers
Copy link
Collaborator Author

This is enforced in the new schema:

project_desc: z
.string()
.max(750) // Would like to lower this further
.describe("Short description of the project"),

Everything passes with the current upper limit of 750 characters. If I try lowering it to 700, there are seven files that fail. It probably wouldn't take much time to shorten those. I don't know how much lower we would want to go, but anyway, you can see how adjusting the schema and then fixing any errors that crop up in the tests is a good workflow.

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

No branches or pull requests

2 participants