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.

Sign up for GitHub

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

fix: remove md that is incompatible with docs #1063

Merged
merged 1 commit into from
Jun 28, 2023
Merged

fix: remove md that is incompatible with docs #1063

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,11 @@ You can now start a local deployment of Shuttle and the required containers with
USE_PANAMAX=disable make up
```

<!-- markdownlint-disable no-blanks-blockquote -->
> Note: `make up` does not start [panamax](https://github.com/panamax-rs/panamax) by default, if you do need to start panamax for local development, run this command with `make COMPOSE_PROFILES=panamax up`.

> Note: `make up` can also be run with `SHUTTLE_DETACH=disable`, which means docker-compose will not be run with `--detach`. This is often desirable for local testing.

> Note: Other useful commands can be found within the [Makefile](https://github.com/shuttle-hq/shuttle/blob/main/Makefile).
<!-- markdownlint-restore -->

The API is now accessible on `localhost:8000` (for app proxies) and `localhost:8001` (for the control plane). When running `cargo run --bin cargo-shuttle` (in a debug build), the CLI will point itself to `localhost` for its API calls.

Expand Down Expand Up @@ -400,4 +398,4 @@ git config --global core.autocrlf true

After you run this command, you should be able to checkout projects that are maintained using CRLF (Windows) again.

[^1]: <https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf>
[^1]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf
Comment on lines -403 to +401
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jonaro00 do you recall why you changed this? Removing it fixes the parsing error in the docs, but it might be needed?

Copy link
Member

@jonaro00 jonaro00 Jun 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Mainly due to markdown lint rules, but as you also have discovered, Mintlify's markdown parser does not even support comments (to disable rules)...

Copy link
Member

Choose a reason for hiding this comment

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

In my other large docs PR, using Mintlify v3, I changed the Contributing sidebar item to be a link to CONTRIBUTING.md instead. Sacrificing the quality (graph etc) from GitHub's rendering to mirror it is a waste IMO. A contributor should not be afraid of starting out on a markdown file on GH.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that is a very fair point, there certainly are some footguns, I encountered a few myself testing this. Our understanding was that they would support mermaid soon, but they must not have had time to integrate it yet. 😅

I will merge this for now so we fix the parsing error, but I think just linking to github is definitely worth considering. I'll ask Ivan if they replied about mermaid as well.