pln-planning-tools / Starmap

Roadmap Planning Tool
https://starmap.site
Other
20 stars 8 forks source link

Create StarMaps Landing Page & Instructions #72

Open juliaxbow opened 1 year ago

juliaxbow commented 1 year ago

Could just be the instructions from GitHub but would be nice to have some guidance for users as to how to use the tool.

To get to the landing page/instructions from within the StarMaps tool, user should be able to click on logo in nav bar.

SgtPooki commented 1 year ago

@wilkyr31d I believe this should be a P0 thing. We could simply render the User-Guide.md on the landing page as a P0?

reidlw commented 1 year ago

I'm not sure what it would mean to "render on the landing page" can you clarify? Minimally, I think it's a P0 to have a link to the user guide. Great call out @juliaxbow and @SgtPooki

reidlw commented 1 year ago

I just saw a render in one of @juliaxbow videos where I see the whole content of the user guide rendered in the space where the roadmap goes if you navigate into the tool without specifying a github issue. I think that's awesome if easy enough to achieve.

juliaxbow commented 1 year ago

Nice! I think that's what @SgtPooki is suggesting we do by rendering the user-guide

reidlw commented 1 year ago

I'm good with it. I'm going to change to status/ready. @SgtPooki if this gets gnarly and risks 11/16 rollout, this is on the P0/P1 line I think. But if you can do it I think it would be great.

SgtPooki commented 1 year ago

yea absolutely. this should be a fairly easy addition

SgtPooki commented 1 year ago

@wilkyr31d @juliaxbow markdown rendered directly from User Guide.md file on landing page: https://starlight-app-git-72-create-starmaps-landing-f4117c-ipfs-ignite.vercel.app/

SgtPooki commented 1 year ago

we don't have a lot of control of the styling without significantly more work. we can adjust this later if it needs anything fancy, but this should be sufficient for now

juliaxbow commented 1 year ago

Can we add padding without too much difficulty so that it's centered (still left justified) on the page?

Also I edited this issue to include how to navigate to the landing page through the tool logo in the navbar. LMK if it should exist as a separate issue.

reidlw commented 1 year ago

+1 to Julia's request. If there's ANY way to get it not smushed up against the leftmost edge that would be a huge win. This can be a P1 to fix it.

@SgtPooki - if you think we can do something, should we just drop priority of this one to P1 since you've already got the basic rendering in place, or should we create a new issue?

SgtPooki commented 1 year ago

Can we add padding without too much difficulty so that it's centered (still left justified) on the page?

Not a problem

Also I edited this issue to include how to navigate to the landing page through the tool logo in the navbar. LMK if it should exist as a separate issue.

No, that's fine. will work on that

juliaxbow commented 1 year ago

Reopening to suggest some changes to font sizes / weight for better readability (ignore other formatting and just look at the redlined comments):

H1: 36 pt (weight: Extra Bold) H2: 28 pt (weight: Medium) H3: 24 pt (weight: Semi Bold) H4: 20 pt (weight: Regular) P1: 16 pt (weight: Regular)

Screen Shot 2022-11-15 at 10 18 09 PM
SgtPooki commented 1 year ago

updated the labels and removed from project because I think we have higher priority items. Open to discuss.