Skip to content

Remove short decriptions? #332

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

Closed
moT01 opened this issue May 14, 2020 · 4 comments
Closed

Remove short decriptions? #332

moT01 opened this issue May 14, 2020 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@moT01
Copy link
Contributor

moT01 commented May 14, 2020

I'm wondering if CodeRoad needs these...
Screen Shot 2020-05-14 at 10 27 54 AM

I really like them, and it looks good on the introduction page. But I'm struggling to come up with a mini description for things. They always just basically say the same thing that the title does.

I would just leave this for now. I'll see if I can work on better info for these spots. Just throwing the idea out there. Maybe if I just remove them from the markdown they wouldn't show up.

@moT01 moT01 added the enhancement New feature or request label May 14, 2020
@ShMcK
Copy link
Member

ShMcK commented May 14, 2020

Do you think it's worth parsing the first 100 or so characters, or just skip a description?

@moT01
Copy link
Contributor Author

moT01 commented May 14, 2020

Parsing the first part of the description? Yea, I thought about that - it's not a bad idea.

I just gave it a quick test, and I can simply put an space in there and nothing will show up....
Screen Shot 2020-05-14 at 10 39 35 AM

So we have that option, which is fine it I want to omit those. Side note: I do get an error when parsing if there's no space.

@moT01
Copy link
Contributor Author

moT01 commented May 14, 2020

I just copy/pasted the first part of the instructions to see what it might look like...

Screen Shot 2020-05-14 at 10 44 32 AM

Not bad. I'm not sure if I like that better, or having the option to leave them empty. I could just copy/paste the first part of the instructions in there I suppose. It's a little more work, but then we have both of those options.

I would just leave it for now.

@argemiront argemiront self-assigned this May 20, 2020
@ShMcK
Copy link
Member

ShMcK commented May 30, 2020

Removed in the build tool next release at coderoad/coderoad-cli#5.

@ShMcK ShMcK closed this as completed May 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants