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

linting #64

Merged
merged 2 commits into from
Nov 14, 2023
Merged

linting #64

merged 2 commits into from
Nov 14, 2023

Conversation

plcplc
Copy link
Contributor

@plcplc plcplc commented Nov 14, 2023

Just fixing a few typos and dead links.

@@ -1,6 +1,6 @@
# Schema

The [schema endpoint](../specification/schema/README.md) should return data describing the data connector's scalar and object types, along with any collections, functions and procedures which are exposed.
The [schema endpoint](../specification/schema/index.html) should return data describing the data connector's scalar and object types, along with any collections, functions and procedures which are exposed.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure this is the right way to link in our markdown setup (i.e., it looks like it's confusing sources and compiled outputs, but the link that ended up in the compiled html still referenced a README.md, which is wrong)

Copy link
Collaborator

Choose a reason for hiding this comment

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

This looks like a known bug rust-lang/mdBook#984.

I don't think fixing it with a link to .html is really better, because it will break the link in the original markdown for anyone reading on GitHub (not recommended, but still).

There is a script in the issue to work around this, but I would say let's just remove this link for now.

@paf31 paf31 merged commit cc036ae into main Nov 14, 2023
2 checks passed
@paf31 paf31 deleted the plc/docs-lint branch November 14, 2023 23:22
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.

2 participants