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
chore: Add static frontmatter to docs #15782
Conversation
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
This reverts commit 822dc55.
These files still have unnecessary
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've gone through all the non-rule docs so far. Will continue with makefile and rules later.
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
Okay, I think I got everything now. 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two questions, but depending on the answers this could be merged as-is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
looks like removing the |
Yikes, that’s not good. Will you share some examples? I’m not having any issues following a sample of links that were changed in this PR. |
the sourcecode link is broken, as we removed - ## Section 1: Get the [Source Code](source-code.md)
+ ## Section 1: Get the [Source Code](source-code) |
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.13.0` -> `8.14.0`](https://renovatebot.com/diffs/npm/eslint/8.13.0/8.14.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.14.0`](https://github.com/eslint/eslint/releases/v8.14.0) [Compare Source](eslint/eslint@v8.13.0...v8.14.0) #### Features - [`ab6363d`](eslint/eslint@ab6363d) feat: Add rule no-constant-binary-expression ([#​15296](eslint/eslint#15296)) (Jordan Eldredge) #### Bug Fixes - [`35fa1dd`](eslint/eslint@35fa1dd) fix: allow project paths to have URL-encoded characters ([#​15795](eslint/eslint#15795)) (Milos Djermanovic) - [`413f1d5`](eslint/eslint@413f1d5) fix: update `astUtils.isDirectiveComment` with `globals` and `exported` ([#​15775](eslint/eslint#15775)) (Milos Djermanovic) #### Build Related - [`c2407e8`](eslint/eslint@c2407e8) build: add node v18 ([#​15791](eslint/eslint#15791)) (唯然) #### Chores - [`735458c`](eslint/eslint@735458c) chore: add static frontmatter to no-constant-binary-expression docs ([#​15798](eslint/eslint#15798)) (Milos Djermanovic) - [`db28f2c`](eslint/eslint@db28f2c) chore: Add static frontmatter to docs ([#​15782](eslint/eslint#15782)) (Nicholas C. Zakas) - [`3bca59e`](eslint/eslint@3bca59e) chore: markdownlint autofix on commit ([#​15783](eslint/eslint#15783)) (Nicholas C. Zakas) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1318 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Ah you mean while browsing the docs via GitHub's code explorer instead of on https://eslint.org/docs? I imagine that's a tradeoff we're okay with. Otherwise we'd have to implement a translation step during site build. |
yes, I was using github. just speaking out in case it is an inadvertent change. 😄 |
* chore: Add static frontmatter to docs * cleanup architecture docs location * Update rule ID check for docs * Update lint check * Update Makefile.js Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Cleanup based on feedback * Fix Makefile.js gensite * Revert "Fix Makefile.js gensite" This reverts commit 822dc55. * Update docs/src/pages/index.md Co-authored-by: Brandon Mills <btmills@users.noreply.github.com> * Remove extra file and resources sections Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
This reverts commit d7638af.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
This adds YAML frontmatter to all of our documentation files and removes all of the inline titles from the pages in preparation for the new docs site. I also updated the Makefile to no longer add in the frontmatter.
There will be a corresponding change in the website to consume this format of documentation:
eslint/archive-website#933
We should be sure to merge the website one first and then this one, just to be safe.
Is there anything you'd like reviewers to focus on?