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.

Sign up for GitHub

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

Jump to bottom

feat: Improve documentation #113

Merged
merged 8 commits into from
Jul 27, 2023
Merged

feat: Improve documentation #113

merged 8 commits into from
Jul 27, 2023

Conversation

taorepoara
Copy link
Member

@taorepoara taorepoara commented Jul 26, 2023 •
edited
Loading

Closes #112

Description of the changes

  • Add style and refactor the Principles page
  • Make the install page clearer
  • Change the template description
  • Upgrade CLI and components API versions
  • Code syntax highlighting

Checklist

  • I didn't over-scope my PR
  • My PR title matches the commit convention
  • I did not include breaking changes
  • I made my own code-review before requesting one

I included unit tests that cover my changes

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

I added/updated the documentation about my changes

  • 📜 README.md
  • 📕 docs/*.md
  • 📓 docs.lenra.io
  • 🙅 no documentation needed

Technical highlight/advice

Added Prism.js for code highlighting

@taorepoara taorepoara self-assigned this Jul 26, 2023
@taorepoara taorepoara linked an issue Jul 26, 2023 that may be closed by this pull request
[Task] Update the docs thanks to the first onboarding feedbacks #112
Closed
6 tasks
@taorepoara taorepoara marked this pull request as ready for review July 26, 2023 15:57
shiipou
shiipou requested changes Jul 27, 2023
View reviewed changes
Copy link
Contributor

@shiipou shiipou left a comment

Choose a reason for hiding this comment

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

Also :

src/markdown/getting-started/install.md Show resolved Hide resolved
src/markdown/getting-started/principles.md Show resolved Hide resolved
@taorepoara
Copy link
Member Author

My bad for the broken links. I thought that the links to a Markdown file were replaced by HTML, but it was in another tool ^^

@taorepoara taorepoara requested a review from shiipou July 27, 2023 09:52
@jonas-martinez jonas-martinez merged commit cf5ed97 into beta Jul 27, 2023
1 check passed
@jonas-martinez jonas-martinez deleted the 112-task-update-the-docs-thanks-to-the-first-onboarding-feedbacks branch July 27, 2023 12:17
@shiipou
Copy link
Contributor

shiipou commented Jul 27, 2023

🎉 This PR is included in version 1.0.0-beta.20 🎉

The release is available on:

Your semantic-release bot 📦🚀

@taorepoara taorepoara mentioned this pull request Jul 28, 2023
Closed
taorepoara added a commit that referenced this pull request Oct 25, 2023
@taorepoara
feat: Improve documentation (#113)
1c25d9e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonas-martinez jonas-martinez jonas-martinez approved these changes

@shiipou shiipou shiipou approved these changes

Assignees

@taorepoara taorepoara

Labels
released on @beta
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Task] Update the docs thanks to the first onboarding feedbacks
3 participants
@taorepoara @shiipou @jonas-martinez