Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script for docs preview #36

Merged
merged 2 commits into from
Dec 28, 2023
Merged

Add script for docs preview #36

merged 2 commits into from
Dec 28, 2023

Conversation

Taucher2003
Copy link
Member

Closes #33

Please note, for this script to work, you need to have telescopium cloned next to pictor.

@Taucher2003 Taucher2003 self-assigned this Dec 25, 2023
Copy link
Contributor

github-actions bot commented Dec 25, 2023

GitLab Pipeline Action

General information

Link to pipeline: https://gitlab.com/code0-tech/pictor/-/pipelines/1120423177

Status: Passed
Duration: 4 minutes

Job summaries

docs:preview

Documentation preview available at https://code0-tech.gitlab.io/-/telescopium/-/jobs/5827717790/artifacts/dist/index.html

storybook:build

Storybook available at https://code0-tech.gitlab.io/-/pictor/-/jobs/5827714148/artifacts/storybook-static/index.html

@nicosammito
Copy link
Contributor

Closes #33

Please note, for this script to work, you need to have telescopium cloned next to pictor.

Can you explain this process more detailed

@Taucher2003
Copy link
Member Author

Can you explain this process more detailed

Basically, assuming you have something like a code0 directory and in there, there is the pictor project. You also need to clone telescopium into that code0 directory, because this project doesn't know how to build docs. Telescopium does.

The work of creating a docs preview is delegated to the telescopium project and for that to work, it needs to have that project available locally.

@nicosammito
Copy link
Contributor

Can you explain this process more detailed

Basically, assuming you have something like a code0 directory and in there, there is the pictor project. You also need to clone telescopium into that code0 directory, because this project doesn't know how to build docs. Telescopium does.

The work of creating a docs preview is delegated to the telescopium project and for that to work, it needs to have that project available locally.

Okay yeh seems good, but we need a well documented md file for contributing

nicosammito
nicosammito previously approved these changes Dec 25, 2023
@Taucher2003 Taucher2003 merged commit 0e766a6 into main Dec 28, 2023
1 check passed
@Taucher2003 Taucher2003 deleted the 33-docs-preview branch December 28, 2023 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

start command for docs
2 participants