671de4170f
Migrated Developer Docs ( #5683 )
...
- Migrated developer docs to Twenty website
- Modified User Guide and Docs layout to include sections and
subsections
**Section Example:**
<img width="549" alt="Screenshot 2024-05-30 at 15 44 42"
src="https://github.com/twentyhq/twenty/assets/102751374/41bd4037-4b76-48e6-bc79-48d3d6be9ab8 ">
**Subsection Example:**
<img width="557" alt="Screenshot 2024-05-30 at 15 44 55"
src="https://github.com/twentyhq/twenty/assets/102751374/f14c65a9-ab0c-4530-b624-5b20fc00511a ">
- Created different components (Tabs, Tables, Editors etc.) for the mdx
files
**Tabs & Editor**
<img width="665" alt="Screenshot 2024-05-30 at 15 47 39"
src="https://github.com/twentyhq/twenty/assets/102751374/5166b5c7-b6cf-417d-9f29-b1f674c1c531 ">
**Tables**
<img width="698" alt="Screenshot 2024-05-30 at 15 57 39"
src="https://github.com/twentyhq/twenty/assets/102751374/2bbfe937-ec19-4004-ab00-f7a56e96db4a ">
<img width="661" alt="Screenshot 2024-05-30 at 16 03 32"
src="https://github.com/twentyhq/twenty/assets/102751374/ae95b47c-dd92-44f9-b535-ccdc953f71ff ">
- Created a crawler for Twenty Developers (now that it will be on the
twenty website). Once this PR is merged and the website is re-deployed,
we need to start crawling and make sure the index name is
‘twenty-developer’
- Added a dropdown menu in the header to access User Guide and
Developers + added Developers to footer
https://github.com/twentyhq/twenty/assets/102751374/1bd1fbbd-1e65-4461-b18b-84d4ddbb8ea1
- Made new layout responsive
Please fill in the information for each mdx file so that it can appear
on its card, as well as in the ‘In this article’ section. Example with
‘Getting Started’ in the User Guide:
<img width="786" alt="Screenshot 2024-05-30 at 16 29 39"
src="https://github.com/twentyhq/twenty/assets/102751374/2714b01d-a664-4ddc-9291-528632ee12ea ">
Example with info and sectionInfo filled in for 'Getting Started':
<img width="620" alt="Screenshot 2024-05-30 at 16 33 57"
src="https://github.com/twentyhq/twenty/assets/102751374/bc69e880-da6a-4b7e-bace-1effea866c11 ">
Please keep in mind that the images that are being used for Developers
are the same as those found in User Guide and may not match the article.
---------
Co-authored-by: Félix Malfait <felix.malfait@gmail.com >
2024-06-03 18:52:43 +02:00
adf64f0a4c
Add known sources dropdown to api docs ( #5204 )
...
closes #5156
2024-04-29 10:39:40 +02:00
43f0b11aab
Fix playground ( #5043 )
...
Some code quality updates on the doc api playgrounds
2024-04-19 18:18:08 +02:00
f847b64fd1
fix serverurl in openapi docs for self hosted instance ( #4390 )
...
* fix serverurl in openapi docs for self hosted instance
* fixed server url slash, moved calculation to enviroment function, fixed openapi path hardcoded api.twenty.com
2024-03-13 12:13:45 +01:00
c53b593ea6
Custom swagger endpoint for docs ( #3869 )
...
* custom swagger endpoint
metadata graphql
remove /rest from endpoint
* fixed pseudo scheme creation
* move graphql playground creation to own file, added navbar to change baseurl and token
* add schema switcher, fix changing url not applied, add invalid overlay
* fix link color
* removed path on Graphql Playground, naming fixes subdoc
* - fixed overflow issue Rest docs
* history replace & goBack
* Small fix GraphQL playground broken
---------
Co-authored-by: Félix Malfait <felix.malfait@gmail.com >
2024-02-08 16:54:20 +01:00
e0405edb38
feat: added webhook list section and updated api key section ( #3567 )
...
* feat: added webhook list section and updated api key ui
* Fix style
* Fix webhook style
* Update setting path
* Add soon pill on not developped features
* Code review returns
---------
Co-authored-by: Lakshay saini <lakshay.saini@finmo.net >
Co-authored-by: martmull <martmull@hotmail.fr >
2024-01-25 17:39:17 +01:00
ed7bd0ba26
2914 graphql api documentation ( #3065 )
...
* Remove dead code
* Create playground component
* Remove useless call to action
* Fix graphiql theme
* Fix style
* Split components
* Move headers to headers form
* Fix nodes in open-api components
* Remove useless check
* Clean code
* Fix css differences
* Keep carret when fetching schema
2023-12-20 12:01:55 +01:00
