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

docs: [Mintlify] Add Slinky Docs #257

Closed
wants to merge 5 commits into from
Closed

Conversation

joshcolts18
Copy link

@joshcolts18 joshcolts18 commented Mar 20, 2024

This PR adds the Slinky Docs on Mintlify

CleanShot 2024-03-20 at 17 49 00

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Publishing Changes

Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with mint.json

Copy link

codecov bot commented Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.34%. Comparing base (a53f451) to head (551aeb9).
Report is 21 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #257      +/-   ##
==========================================
- Coverage   63.66%   62.34%   -1.33%     
==========================================
  Files         213      215       +2     
  Lines        9228     9475     +247     
==========================================
+ Hits         5875     5907      +32     
- Misses       2822     3023     +201     
- Partials      531      545      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aljo242 aljo242 changed the title [Mintlify] Add Slinky Docs docs[Mintlify]: Add Slinky Docs Mar 20, 2024
@aljo242 aljo242 changed the title docs[Mintlify]: Add Slinky Docs docs: [Mintlify] Add Slinky Docs Mar 20, 2024
@bpiv400 bpiv400 closed this Jun 20, 2024
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.

3 participants