Commit Graph

35 Commits

Author SHA1 Message Date
a523190943 User guide & vale setup (#2260)
* 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

* set up vale, added to docs

* vale config file

* revised backend best practices

* connecting zapier and twenty

* added warning for zapier
2023-10-30 18:01:58 +01:00
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
cb6ee90fa6 Doc addition & changes (#2152)
* 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
2023-10-20 15:47:44 +02:00
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
54735c4880 2038 zapier integration 1 initialize a zapier app with a twenty related account (#2089)
* Add doc for Zapier development

* Add twenty-zapier package

* Install zapier packages

* Update doc

* Add twenty-zapier app

* Update doc

* Update apiKey slug

* Update integration

* Update create people to person

* Update version

* Fix lint

* Remove useless comments

* Update docs

* Update version

* Update naming

* Add prettier

* Simplify docs

* Remove twenty related stuff from public doc

* Use typescript boilerplate

* Update details
2023-10-17 21:00:20 +02:00
a6542719df Addresses issue #1906 (#2074)
* 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
2023-10-16 22:06:07 +02:00
fa9303f545 Refactored Storybook UI (#2020)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components
2023-10-14 21:22:47 +02:00
258685467b Refactor UI folder (#2016)
* 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

* refactoring modules/ui

* refactoring modules/ui

* Change folder case

* Fix theme location

* Fix case 2

* Fix storybook

---------

Co-authored-by: Nimra Ahmed <nimra1408@gmail.com>
Co-authored-by: Nimra Ahmed <50912134+nimraahmed@users.noreply.github.com>
2023-10-14 00:04:29 +02:00
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
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
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
59a7e7ead3 Add troubleshooting doc (#1852)
* - add troubleshooting doc

* fix duplicate
2023-10-04 15:07:02 +02:00
ab4f978a00 Update documentation nav font-size 2023-09-29 19:16:38 +02:00
ae0acd508a docs: add page level sidebar (#1749)
* POC: docs: add page level sidebar

Closes #1341

* docs: hide level 1 test page from navbar
2023-09-29 17:50:21 +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
8d8c81c02c Add Figma documentation (#1705) 2023-09-21 14:56:28 -07: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
390e70a196 Added a first round of docs for front end (#1246) 2023-08-17 15:16:48 -07:00
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
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
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
a65853dc2e Improve documentation (#349)
* Improve documentation content
* Improve documentation style
2023-06-21 16:23:31 -07:00
3ae6405f4d Add Algolia Search + other quick improvements to docs (#198) 2023-06-05 18:48:12 +02:00
f906533b29 Fix broken GraphiQL in documentation (#180) 2023-06-01 19:23:15 +02:00
05c8fac6d6 Add docs CI and fix docs build (#176)
* Add docs CI and fix docs build

* Fix CI name
2023-06-01 16:21:31 +02:00
14c0119c4b Update documentation, add GraphiQL to docs (#175)
* Update docusaurus and fix security vulnerabilities

* Begin cleanup docs

* Remove redocusaurus

* Add graphiql in doc

* Add architecture schema

* New tableIcons and cleanup docs
2023-06-01 15:05:53 +02:00
c61beb1066 Reorganize icons for doc and manigest.json (#166)
* Reorganize icons for doc and manigest.json

* Fix icons path

* Fix path in index.html
2023-05-31 15:44:38 +02:00
9a3aa1d3d2 Readme visual update (#146)
* new header for Readme

* new header for Readme

* new header for Readme

* Correct naming and changed assets

* Applied Strapi method for dark-mode images

* Corrected logo-square-dark look

* Corrected a typo

* Corrected spacing
2023-05-27 08:39:26 +02:00
f79a45e7e6 Add svg logos to docs (#143) 2023-05-26 09:59:09 +02:00
42bf653e4a Improve documentation (#82)
* Propose new doc architecture

* Many improvements to documentation (styling, structure...)

* Remove modules added inadvertently + continue improving styling

* Swizzle navbar item to add support for custom icon

* Additional doc styling

* Setup docs for API and redirect homepage for docs
2023-04-26 19:10:17 +02:00
04d498668d Remove broken link in doc 2023-04-25 23:50:31 +02:00
1e3540863a Improve styling 2023-04-20 22:57:55 +02:00
db62346bfa Cleanup and start organizing docs 2023-04-20 17:35:16 +02:00
167426e41c Install Docusaurus 2023-04-19 10:47:23 +02:00