Skip to content
This repository was archived by the owner on Aug 15, 2023. It is now read-only.

fix: docs for all #502

Merged
merged 23 commits into from
Jun 18, 2022
Merged

fix: docs for all #502

merged 23 commits into from
Jun 18, 2022

Conversation

ascariandrea
Copy link
Collaborator

@ascariandrea ascariandrea commented May 5, 2022

To serve the documentation you need first to build the OpenAPI documentation with:

yarn yt:shared open-doc-api
yarn tk:shared open-doc-api
yarn ycai open-doc-api

and then you can run yarn docs start to serve documentation at http://localhost:3000

@ascariandrea ascariandrea marked this pull request as draft May 5, 2022 13:50
@ascariandrea ascariandrea linked an issue May 5, 2022 that may be closed by this pull request
32 tasks
Base automatically changed from fix/yttrex-ads-ext to daily May 14, 2022 22:05
@ascariandrea ascariandrea force-pushed the fix/docs-for-all branch 3 times, most recently from 1506d97 to 5b6b1ee Compare May 17, 2022 13:54
@ascariandrea ascariandrea force-pushed the daily branch 2 times, most recently from 5759ec9 to 2bee5b7 Compare May 19, 2022 14:59
@vecna vecna marked this pull request as ready for review June 1, 2022 08:21
@vecna
Copy link
Member

vecna commented Jun 1, 2022

I could generate the open API docs, but I couldn't start the docusaurus webserver?
The error mentions electron-to-chromium/versions as a missing package

image

@@ -18,7 +18,7 @@ Having trouble? We’d like to help!

- Check the **[Github](https://github.com/tracking-exposed)** repo, report bugs or contribute. ❤️

- Join the community in Tracking Exposed **[Slack](trackingexposed.slack.com)**.
- Join the community in Tracking Exposed **[Slack](https://trackingexposed.slack.com)**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, slack isn't supposed to be publicly accessible. we don't have a place (yet) for support. perhaps, if we move all our channels as private, we can consider this.

@vecna vecna merged commit 9846400 into daily Jun 18, 2022
@vecna vecna deleted the fix/docs-for-all branch June 18, 2022 15:05
ascariandrea added a commit that referenced this pull request Jul 6, 2022
* fix: docs for all

* refactor: endpoints organization by platform

* chore: upgrade typescript and ts-node

* chore(docs): defined build script

* fix: docs build

* docs(guardoni): installation and usage sections

* docs: guardoni development section with build, pkg and test

* fix(tktrex): metadata models definition

* docs(guardoni): replace getting started section with electron

* ci: defined workflow for docs

* fix: typings for documented endpoint instance

This will likely be moved to the 'ts-endpoint' dependency soon.

* fix: ycai build with path to '@tktrex/shared' package

* fix(yttrex): endpoints import for extension background

* ci: run docs workflow for our set of branch names

* fix(yttrex): youchoose endpoints import

* used the 128x128 trex logo instead of yttrex

* docs: dark logo

* docs: intro updated

* fix: swagger provider model parsing

* fix(shared): models exports for swagger doc compatibility

* fix(docs): link configuration

* fix(tktrex): contribution event model definition with possibly undefined values

* fix(docs): link to our slack

Co-authored-by: Claudio <claudio@syrianarchive.org>
Co-authored-by: spaghettinucleari <spaghettinucleari@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[workspace] Documentation
3 participants