Skip to content

Add /docs #209

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

Open
wants to merge 88 commits into
base: master
Choose a base branch
from
Open

Add /docs #209

wants to merge 88 commits into from

Conversation

DylanCkawalec
Copy link

@DylanCkawalec DylanCkawalec commented Jun 12, 2025

This is a full documentation update. All documents from the original have been preserved, and we have a full deployment guide, full core component list and their breakdowns. The guide starts online here 'https://phalanetwork.mintlify.app/docs/getting-started/start' which can be added to the description of the dstack repo, so users can click on these docs and view them any time. I think it would be helpful if you guys had a domain we can use to point to this, such as dstack.docs. This is hosted currently for free over mintlyfy, and can be deployed using mintlify dev after installing the mint npx packages if you want to run the documentation locally.

I recommend exploring the main getting started page. This leads to the installation and then deployment guides. Many of the core concepts have their own implementation guides which are found in the core-components. Many of the basic research and summaries for the cryptography libraries used are sectioned out in the secruity and research section which I think can expand more and more over time. the docs.json was added to format the documentation.

this added

  1. the overview of dstack
  2. the getting started guides for Installation, deployment and development tutorials
  3. a full core component section breakdown
  4. the security and research for each component in dstack, that reviews the cryptography used in the framework
  5. the additional community section to telegrams, videos and other group discussions online
  6. then additional reference links scattaered about and of course the armadillo to add that visual story telling through the documentation.

DylanCkawalec and others added 27 commits June 8, 2025 20:29
readme step 4 command line guide
Change : New deployment guide update, walkthrough.
Enhancement : Update Structure overwrite
Feat : Additional Deployment Guide, and reactive sub pages
Feat: Deployment UI enhancement
Added /docs ; built in mint, core concepts, guides, security reviews and community links & additional images.
@DylanCkawalec DylanCkawalec changed the base branch from docs-deployment to master June 12, 2025 02:54
@amiller amiller self-requested a review June 21, 2025 21:09
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.

1 participant