Commit Graph

24 Commits

Author SHA1 Message Date
3913e1b6a0 input component ui docs (#2873) 2023-12-09 10:39:50 +01:00
2171eff1a0 minor improvements to ui component docs (#2805)
* minor improvements to ui component docs

* polish queue.mdx, remove duplicate icon
2023-12-04 08:32:35 +01:00
b1d748f8bd UI Component docs (Display & Feedback components) (#2453)
* ui docs

* UI docs for display components

* docs for display and feedback components

* minor edits

* minor changes

* cleaned up code

* Move telemetry

* Revised Feedback/Display UI docs & added input UI docs

* Docs for Input components

* updated icons

* docs for input/components

* minor edits based on feedback

* add css to ui components

* Fixed spacing issue in button groups

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
2023-11-22 22:35:34 +01:00
448f256a35 Add env variable docs (#2440)
* - add env variable docs

* - danger.js rule

* - fix value

* Fix Danger CI setup

* Add token in CI

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2023-11-14 10:41:09 +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
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
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
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
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
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
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