Skip to content

feat(site): display template's readme first on template page #6863

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

Merged
merged 8 commits into from
Apr 3, 2023

Conversation

rodrimaia
Copy link
Contributor

@rodrimaia rodrimaia commented Mar 29, 2023

~~This pull request moves the Readme section on the template page to appear first, replacing its previous position after the DAU and Template Resources sections.

We decided to not limit the readme section height for now. Another idea would be to have the option to collapse the section if we realize templates readme tend to be big ~~

We decided to have a new Docs tab with the Readme. We created also a redirect to point bookmarked links of /templateName#readme to the new tab!

Loom video:
https://www.loom.com/share/3c83e8e528d744b1afb8fb8b049f8017

@github-actions
Copy link

github-actions bot commented Mar 29, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@rodrimaia
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@rodrimaia
Copy link
Contributor Author

recheck

cdrcommunity added a commit to coder/cla that referenced this pull request Mar 29, 2023
@kylecarbs
Copy link
Member

Thoughts on DAU still coming first? Because README hasn't been near the top, users may not have actually filled it out.

Maybe we ask for some feedback in Discord.

@BrunoQuaresma
Copy link
Collaborator

I think asking this in Discord is a good one.

@BrunoQuaresma
Copy link
Collaborator

@rodrimaia I think we can move the chart to be the first element on the screen.

Copy link
Collaborator

@BrunoQuaresma BrunoQuaresma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it is a tiny change, I'm approving it so you can merge it right away. Just remember to check Chromatic checks and approve the changes before merge!

@rodrimaia rodrimaia requested a review from BrunoQuaresma March 31, 2023 19:17
@rodrimaia
Copy link
Contributor Author

Since it is a tiny change, I'm approving it so you can merge it right away. Just remember to check Chromatic checks and approve the changes before merge!

@BrunoQuaresma sorry Bruno, asking for a new review since we changed the scope of this PR

Copy link
Collaborator

@BrunoQuaresma BrunoQuaresma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rodrimaia rodrimaia enabled auto-merge (squash) April 3, 2023 18:16
@rodrimaia rodrimaia merged commit a1371db into main Apr 3, 2023
@rodrimaia rodrimaia deleted the move_readme_template_page branch April 3, 2023 18:18
@github-actions github-actions bot locked and limited conversation to collaborators Apr 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants