Commit Graph
38 Commits
Author SHA1 Message Date
Nimra AhmedandGitHub 398a8d732d changes as per vale warnings (#2353)
* changes as per vale warnings

* changes acc to feedback
2023-11-07 11:39:29 +01:00
2221c68dff Improved user guide, added CI vale for docs (#2308)
* restructured user guide, minor fixes

* added index file for user guide

* github actions for vale

* testing workflow

* CI vale

* changes as per vale's suggestions

* set CI vale on pull request

* adding homebrew script to macos infra setup file

* fix CI errors

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* vale testing complete

* vale cleanup

* vale test

* vale test for github-pr-check

* vale test for github-pr-check

* vale test for github-pr-check

* vale test for github-pr-check

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* swizzled doc cards to add icons

* Align CI params to other CIs

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2023-11-03 17:02:30 +01:00
Nimra AhmedandGitHub 515ef25a72 Changes to documentation (#2209)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links

* doc addition and changes

* introduce user guide & graphql api
2023-10-24 11:36:43 +02:00
Nimra AhmedandGitHub bea9d0835b Doc changes (#2124)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links
2023-10-19 16:32:29 +02:00
Nimra AhmedandGitHub 13db1bd0a6 Improvements to the doc (#1989)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

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

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons
2023-10-13 09:13:13 +02:00
Charles BochetandGitHub edc060fce7 Introduce UI Components documentation (#1926)
* new contributor guide folder architecture

* update content pass 1

* Prepare UI component folder to receive componentns

* Add component doc example for button

* Fix broken links

* Fix broken links

* Fix images
2023-10-08 13:21:54 +02:00
Nimra AhmedandGitHub 7b6ee4e0bf Update README and Documentation (#1875)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

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

* changes as per code review
2023-10-07 11:24:44 +02:00
BOHEUSandGitHub 10c39e4501 Update troubleshooting.mdx (#1895)
Updated troubleshooting.mdx with possible solution to Docker related problems
2023-10-06 11:12:42 +02:00
GauravandGitHub b8282e6789 Added script to setup database locally on Linux/WSL (#1879)
* Created script to install and setup PostgreSQL database for Linux/WSL

* Updated Docs
2023-10-05 16:17:27 +02:00
brendanlaschkeandGitHub 59a7e7ead3 Add troubleshooting doc (#1852)
* - add troubleshooting doc

* fix duplicate
2023-10-04 15:07:02 +02:00
bc3fe59312 feat: added an enlint rule to enforce no-type-import (#1838)
* feat: added an enlint rule to enforce no-type-import

* Update style-guide.mdx

---------

Co-authored-by: aman1357 <101919821+aman1357@users.noreply.github.com>
2023-10-04 11:06:54 +02:00
bosiraphaelandGitHub 35fb2576b7 added figma link to README.md (#1835)
* added figma link to README.md

* added figma to the recommended extensions for the project

* updated useful tips in 'work with Figma' section of the docs to add Figma extension for VSCode

* removing yarn.lock

* modified Figma extension docs in 'Work with Figma'

* added Mdx Preview extension to recommended extensions
2023-10-03 12:50:05 +02:00
1c35ccce4e docs: redesign docs collapsible categories (#1748)
* docs: redesign docs collapsible categories

Closes #1341

* Fix people creation from People table page

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
2023-09-29 16:22:04 +02:00
ba86be2c5b Remove the {...props} pattern and props coupling, and create an eslint rule for that (#1733)
* Remove the {...props} pattern and props coupling, and create an eslint rule for that

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

* Add another test to the new rule

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>
2023-09-26 11:05:33 +02:00
Charles BochetandGitHub 8d8c81c02c Add Figma documentation (#1705) 2023-09-21 14:56:28 -07:00
Charles BochetandGitHub 2d758c990b Fix merge issue flexible backend (#1685)
* Fix merge issue flexible backend

* Fix tests

* Try fix tests

* Try fix tests
2023-09-20 19:11:21 -07:00
Rajesh Kumar PadhyandGitHub ff4a2074e6 Update local-setup.mdx: Fix typo (#1646) 2023-09-19 11:51:47 +02:00
00a3c8ca2b Change to using arrow functions (#1603)
* Change to using arrow functions

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Add lint rule

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
2023-09-15 18:41:10 -07:00
Lucas BordeauandGitHub 28ca9a9e49 Refactor/new menu item (#1448)
* wip

* finished

* Added disabled

* Fixed disabled

* Finished cleaning

* Minor fixes from merge

* Added docs

* Added PascalCase

* Fix from review

* Fixes from merge

* Fix lint

* Fixed storybook tests
2023-09-06 16:41:26 +02:00
Lucas BordeauandGitHub 2ac32e42c5 Added enums use case (#1428) 2023-09-04 11:35:27 +02:00
Lucas BordeauandGitHub e4dd2b0633 Doc fixes (#1385) 2023-08-30 14:28:34 +02:00
ddcfe5f0ac chore(docs): Update the best practices page (#1303)
* chore(docs): Update the best practices page

Co-authored-by: v1b3m <vibenjamin6@gmail.com>

* Add minor refactors

Co-authored-by: v1b3m <vibenjamin6@gmail.com>

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
2023-08-29 10:34:51 +02:00
WeikoandGitHub 9b34a0ff3d Add styled component rule (#1261)
* Add StyledComponent rule

* update doc

* update doc

* update doc
2023-08-17 20:58:02 -07:00
Lucas BordeauandGitHub 390e70a196 Added a first round of docs for front end (#1246) 2023-08-17 15:16:48 -07:00
WeikoandGitHub c9549c3833 [docs] add folder architecture doc (#1221)
* [docs] add folder architecture doc

* update

* add internal

* improve doc
2023-08-15 15:15:07 -07:00
Charles BochetandGitHub cd3a32e555 [Docs] Update WSL instructions + fix broken links (#1204)
Update WSL instructions
2023-08-14 11:25:52 -07:00
Charles Bochet 428acf4a13 Fix windows-setup doc url 2023-08-10 08:30:56 -07:00
Charles Bochet 91670df1db Fix doc 2023-08-10 08:03:52 -07:00
Charles Bochet be9a2cefeb Fix doc 2023-08-09 22:43:47 -07:00
510c466271 Add WSL instruction and IDE setup instruction (#1150)
* Add WSL instruction and IDE setup instruction

* Fix setup

* Fix setup

* Fix

* Update docs/docs/developer/additional/ide-setup.mdx

Co-authored-by: Weiko <corentin@twenty.com>

---------

Co-authored-by: Weiko <corentin@twenty.com>
2023-08-09 22:24:15 -07:00
b028d9fd2a Add deploy buttons and clean environment variables (#974)
* add render.yaml

* Clean environment variables



---------

Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-31 14:36:04 -07:00
Indrajeet NikamandGitHub be835af48b docs: fix instructions to start projects in the docker setup flow (#995) 2023-07-30 10:52:31 -07:00
c2d6abde65 [Bug fix] Reference container name instead of localhost for postgres url in .env file (#808)
* url should reference container name instead of localhost

* add context for the postgres URL change, when installing with Docker. Also minor grammar/typo changes.

* return the postgres URL to its original value, which corresponds with the recommended (yarn) installation.

---------

Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com>
2023-07-25 10:17:49 -07:00
willkrakowandGitHub 097627fcab Fix typos/language in docs (#824)
* Fix typos/language in docs

* Fix typos
2023-07-22 18:48:31 +02:00
Ikko Eltociear AshimineandGitHub ad3e0ea340 Fix typo in local-setup.mdx (#822)
PostgresSQL -> PostgreSQL
2023-07-22 00:38:07 -07:00
Charles BochetandGitHub 79fccb0404 Add optimistic rendering on right drawer title (#786)
* Add optimistic rendering on right drawer title

* Fix

* Fix

* Fix

* Fix

* Fix

* Fix
2023-07-20 23:58:21 -07:00
Charles BochetandGitHub e65c7ee6fe Update install (#785) 2023-07-20 22:59:03 -07:00
Charles BochetandGitHub ca5191169f Update docs, remove password strong regex, hide tasks (#755)
* Update docs, remove password strong regex, hide tasks

* Update docs
2023-07-19 09:45:31 -07:00