Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

doc(website): Run cargo lintdoc #3567

Merged
merged 4 commits into from
Nov 6, 2022
Merged

doc(website): Run cargo lintdoc #3567

merged 4 commits into from
Nov 6, 2022

Conversation

95th
Copy link
Contributor

@95th 95th commented Nov 6, 2022

Summary

cargo lintdoc output is dirty.

Resolves:

Test Plan

None

@95th 95th requested a review from a team November 6, 2022 06:43
@netlify
Copy link

netlify bot commented Nov 6, 2022

Deploy Preview for docs-rometools ready!

Name Link
🔨 Latest commit dd0495e
🔍 Latest deploy log https://app.netlify.com/sites/docs-rometools/deploys/6367c5926eb84000080dd7e1
😎 Deploy Preview https://deploy-preview-3567--docs-rometools.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ematipico
Copy link
Contributor

@95th
Copy link
Contributor Author

95th commented Nov 6, 2022

@ematipico Do you mean the category keys? the links seem to be already pointing to https://rome.tools/docs/..

@MichaReiser
Copy link
Contributor

MichaReiser commented Nov 6, 2022

Please @sebmck have a look at this PR.

@ematipico
Copy link
Contributor

@ematipico Do you mean the category keys? the links seem to be already pointing to https://rome.tools/docs/..

The URL of the rules have changed since we changed the website, and this is something we missed. (this is on us) This is the new URL of the rules: https://docs.rome.tools/lint/rules/usealttext/

If you go to the page, check one of the diagnostics and click the link rendered (the name of the rule), it points to an URL that returns 404.

@ematipico
Copy link
Contributor

Here's the error returned by Netlify:

2:00:53 PM: > build:styles
2:00:53 PM: > sass --style=compressed src/styles:src/_includes/styles
2:00:54 PM: [11ty] Problem writing Eleventy templates: (more in DEBUG output)
2:00:54 PM: [11ty] You’re trying to use a layout that does not exist: layouts/docs.liquid (undefined) (via Error)
2:00:54 PM: [11ty]
2:00:54 PM: [11ty] Original error stack trace: Error: You’re trying to use a layout that does not exist: layouts/docs.liquid 

@95th 95th requested a review from leops as a code owner November 6, 2022 14:18
@95th
Copy link
Contributor Author

95th commented Nov 6, 2022

@ematipico Updated. please take a look

Copy link
Contributor

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

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

Awesome, thank you

@MichaReiser MichaReiser changed the title Run cargo lintdoc doc(website): Run cargo lintdoc Nov 6, 2022
@MichaReiser MichaReiser merged commit e0eb7e2 into rome:main Nov 6, 2022
@95th 95th deleted the lintdoc_dirty branch November 6, 2022 17:37
jeysal added a commit to jeysal/rometools that referenced this pull request Nov 8, 2022
* upstream/main:
  fix(ci): fix the release workflows for the stable release (rome#3583)
  Fix logo container margin
  Fix mobile docs regressions
  perf: End-to-end Linter and Formatter benchmarks (rome#3570)
  doc: VS Code extension (rome#3579)
  refactor(rome_cli): refactor the threading of parallel traversal to increase occupancy (rome#3577)
  [docs] Add navigation dropdown for docs (rome#3578)
  doc(rome_cli): Document `--files-max-size` option
  perf(rome_js_semantic): Use FX Hash function (rome#3565)
  fix(rome_js_analyzer): `noInvalidConstructorSuper` false positive for class expressions (rome#3561)
  Clean up mobile navigation
  doc(website): Run `cargo lintdoc` (rome#3567)
  doc: Fix install command
  Fix mobile code blocks
  Fix dark mode logo
  Update links
  Implement new website (rome#3556)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants