Added Overview page & edited Getting Started page #1875

nimraahmed · 2023-10-05T03:34:50Z

@FelixMalfait Added Overview page & edited Getting Started page to the documentation

CLAassistant · 2023-10-05T03:34:55Z

All committers have signed the CLA.

FelixMalfait

Thanks!!!

FelixMalfait · 2023-10-05T05:21:10Z

docs/docs/start/getting-started.mdx

 sidebar_custom_props:
-  icon: TbBolt
+  icon: TbDeviceDesktop


Isn't TbDeviceDesktop already used elsewhere? I didn't check but assume it would be for local setup. Make sure it isn't used twice, that would be ugly :)

FelixMalfait · 2023-10-05T05:25:17Z

docs/docs/start/getting-started.mdx


-If you are looking to install the project locally, either to try it or to contribute, check out our [developer guide](/developer/local-setup).
+## Prerequisites


Did you copy/paste the content from another page? We'd like to avoid duplicate content from one page to another.
Maybe you planned to remove it after? We try not to merge PR in an intermediate state. If you raise a PR it's better if it doesn't break anything or introduce any bad pattern

FelixMalfait · 2023-10-05T05:26:30Z

docs/package-lock.json

Please use yarn exclusively and don't introduce this file

FelixMalfait · 2023-10-05T05:33:50Z

docs/docs/start/overview.mdx

+
+Twenty is a modern CRM offering the flexibility of open source, advanced features, and a sleek design that puts teams in full control. 
+
+Twenty's codebase is adaptable, fostering a collaborative environment where every user can contribute. This extensible and modular design ensures our product evolves with you, cultivating mutually beneficial growth that promotes progress and innovation.


I'm sorry I know we wrote all of this text in README (probably I committed it), but I really don't like it anymore haha.
I'll send you things we can take inspiration from in Discord

nimraahmed · 2023-10-07T06:36:50Z

@FelixMalfait
Changes made in recent commits:

Added an overview page with more details about the product
Fixed edit link in the docs
Moved self-hosting above developer guide in the docs
Moved glossary to additional resources in the docs
Revised project readme
Cleaned up and edited local setup page in the docs to make steps clearer & more structured
Deleted sweep.yaml, and .ergomake and .devcontainer folders
Added contributing.md, moved security.md to .github

FelixMalfait

Great!

FelixMalfait · 2023-10-07T06:48:52Z

README.md

@@ -7,11 +7,12 @@
 </p>

 <h2 align="center" >A Modern Open Source CRM </h3>
-<p align="center">Crafted with Precision. Built for Success.</p>
+<p align="center">CRM flexibility, tailored to your unique business needs</p>


Still not a huge fan but it's already an improvement so we can merge it this way!

FelixMalfait · 2023-10-07T06:53:32Z

README.md

@@ -21,31 +22,37 @@
    </picture>
  </a>
 </p>
+<br>
+
+We’ve spent thousands of hours grappling with traditional CRMs/platforms like HubSpot, Pipedrive and Salesforce to align them with our business needs, only to end up frustrated—customizations are complex and the closed ecosystems of these platforms can feel restrictive.


Could we change "Hubspot, Pipedrive and Salesforce" to "Salesforce or Pipedrive"

FelixMalfait · 2023-10-07T06:59:26Z

README.md

+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-dark.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-light.png">
+      <img src="./docs/static/img/preview-light.png" alt="Companies view" />


I think we messed up initially. What is this tag with a different image?

FelixMalfait · 2023-10-07T07:00:03Z

README.md

@@ -80,6 +87,15 @@ Below are the features we have implemented to date.
    </picture>
 </p>

+<p align="center">


No title? For consistency. Design might be a bit odd otherwise no?

FelixMalfait · 2023-10-07T07:02:01Z

README.md

-    <img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" height="40">
-  </picture>
-</a>
+Welcome to the future of CRM. Welcome to Twenty.


Maybe I'd get rid of this as it's not necessary and a bit too much marketing speak

FelixMalfait · 2023-10-07T07:02:16Z

README.md

-# Office hours
-Want to meet the team? Get direct support?
-Feel free to book a slot during our office hours.
+🚀 Get Started with [Twenty](https://docs.twenty.com/developer/local-setup). 


Link on full CTA (including get started...)?

FelixMalfait · 2023-10-07T07:04:41Z

docs/docs/developer/_category_.json

@@ -1,4 +1,4 @@
 {
  "label": "Developer guide",


Should we rename it? Maybe you've planned it for future steps with other changes we have discussed. But we need to clarify contributing VS extending the CRM which isn't the same

README.md

Added Overview page

5dce29e

nimraahmed and others added 2 commits October 5, 2023 09:03

Revised Getting Started page

0ecb421

Minor revision

ea1841d

FelixMalfait reviewed Oct 5, 2023

View reviewed changes

charlesBochet added the -PR: awaiting author label Oct 5, 2023

nimraahmed and others added 3 commits October 6, 2023 17:39

Merge branch 'twentyhq:main' into main

bf376bd

Edited readme, minor modifications to docs

77bbb88

Removed sweep.yaml, .devcontainer, .ergomake

9872f4e

Moved security.md to .github, added contributing.md

a15002b

FelixMalfait reviewed Oct 7, 2023

View reviewed changes

changes as per code review

ef4c46d

FelixMalfait approved these changes Oct 7, 2023

View reviewed changes

FelixMalfait merged commit 7b6ee4e into twentyhq:main Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Overview page & edited Getting Started page #1875

Added Overview page & edited Getting Started page #1875

nimraahmed commented Oct 5, 2023

CLAassistant commented Oct 5, 2023 •

edited

Loading

FelixMalfait left a comment

FelixMalfait Oct 5, 2023

FelixMalfait Oct 5, 2023

FelixMalfait Oct 5, 2023

FelixMalfait Oct 5, 2023

nimraahmed commented Oct 7, 2023 •

edited

Loading

FelixMalfait left a comment

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023

FelixMalfait Oct 7, 2023


		If you are looking to install the project locally, either to try it or to contribute, check out our [developer guide](/developer/local-setup).
		## Prerequisites


		Twenty is a modern CRM offering the flexibility of open source, advanced features, and a sleek design that puts teams in full control.

		Twenty's codebase is adaptable, fostering a collaborative environment where every user can contribute. This extensible and modular design ensures our product evolves with you, cultivating mutually beneficial growth that promotes progress and innovation.

Added Overview page & edited Getting Started page #1875

Added Overview page & edited Getting Started page #1875

Conversation

nimraahmed commented Oct 5, 2023

CLAassistant commented Oct 5, 2023 • edited Loading

FelixMalfait left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nimraahmed commented Oct 7, 2023 • edited Loading

FelixMalfait left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Oct 5, 2023 •

edited

Loading

nimraahmed commented Oct 7, 2023 •

edited

Loading