User guide layout (#5016)

- Modified CSS: font-size, colors, margins...

- Added an ArticleContent Component that will be used for the changelog
and user guide articles, which contains the styles for each titles,
paragraphs, images etc.

- Added link to User Guide in footer

- Added a UserGuideWarning Component: 

<img width="332" alt="Screenshot 2024-04-17 at 18 14 48"
src="https://github.com/twentyhq/twenty/assets/102751374/0f5c601b-a2c0-4c63-baeb-1990d65fc332">

- Added a UserGuideEditContent Component:

<img width="394" alt="Screenshot 2024-04-17 at 18 16 24"
src="https://github.com/twentyhq/twenty/assets/102751374/6c7c3bd4-c5bb-4d02-8f93-bd99bc30ce7b">

- Added a UserGuideLink Component (for usage in MDX to allow links to
open in new tab)

- Fixed table of content

- Made responsive

---------

Co-authored-by: Ady Beraud <a.beraud96@gmail.com>
Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
This commit is contained in:
Ady Beraud
2024-04-22 18:04:26 +03:00
committed by GitHub
parent 68662fa543
commit b9a7eb5a98
44 changed files with 730 additions and 272 deletions
@@ -5,29 +5,29 @@ icon: IconGitHub
image: /images/user-guide/github/github-header.png
---
# About
## About
The Twenty GitHub repository hosts a vast array of resources like source code, documentation, discussions, and issue tracking. This is where you will be able to access the full code behind Twenty.
[Visit Twenty on Github](https://github.com/twentyhq/twenty)
# Contributing
## Contributing
Contributing to the Twenty project on GitHub is a rewarding way to help improve the software you use. Whether you're fixing bugs, suggesting features, or improving documentation, your contributions are welcome.
## Reporting Issues
### Reporting Issues
Encounter an issue? [Create an issue](https://github.com/twentyhq/twenty/issues/new) on GitHub, providing as much detail as possible.
Encounter an issue? <ArticleLink href="https://github.com/twentyhq/twenty/issues/new">Create an issue</ArticleLink> on GitHub, providing as much detail as possible.
<img src="/images/user-guide/github/new-issue.png" style={{width:'100%'}}/>
## Suggesting Features
### Suggesting Features
What improvements would you like to see on Twenty? No matter your technical know-how, you can join [the conversation here](https://github.com/twentyhq/twenty/discussions).
What improvements would you like to see on Twenty? No matter your technical know-how, you can join <ArticleLink href="https://github.com/twentyhq/twenty/discussions">the conversation here</ArticleLink>.
<img src="/images/user-guide/github/github-conversations.png" style={{width:'100%'}}/>
## Coding a feature
### Coding a feature
Start your journey by finding beginner-friendly tasks:
@@ -39,11 +39,11 @@ Start your journey by finding beginner-friendly tasks:
Ensure you're assigned to the issue to avoid overlapping work with other contributors.
## Code of Conduct
### Code of Conduct
Remember to adhere to Twenty's [Code of Conduct](https://github.com/twentyhq/twenty/blob/main/.github/CODE_OF_CONDUCT.md) throughout your contribution process.
Remember to adhere to Twenty's <ArticleLink href="https://github.com/twentyhq/twenty/blob/main/.github/CODE_OF_CONDUCT.md">Code of Conduct</ArticleLink> throughout your contribution process.
# Discord
## Discord
If you have any question, for example on how to contribute, join the community on [Discord](https://discord.gg/cx5n4Jzs57)
@@ -51,4 +51,6 @@ If you have any question, for example on how to contribute, join the community o
<br/>
<br/>
Thank you for contributing to Twenty ❤️
Thank you for contributing to Twenty ❤️
<ArticleEditContent articleTitle="github.mdx"></ArticleEditContent>