chore: seed docs script #231
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dependencies outside root package.json to resolve conflicts. Also the seed dependencies are not needed for other projects using Head Start. to do: - better link replacement in md files - add a partial listing all documents?
Deploying head-start with
|
| Latest commit: |
a00c799
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4274c3b9.head-start.pages.dev |
| Branch Preview URL: | https://chore-seed-docs.head-start.pages.dev |
jbmoelker
added
help wanted
jbmoelker
commented
Jan 2, 2025
| import { fromMarkdown } from 'mdast-util-from-markdown'; | ||
| import type { Root } from 'mdast'; | ||
| import { toHast } from 'mdast-util-to-hast'; | ||
| import { hastToStructuredText, type HastRootNode } from 'datocms-html-to-structured-text'; |
There was a problem hiding this comment.
Astro check in the CI lint job fails on this module. Not sure why it's not found. Locally I can verify it exists. Maybe it has to do with the "type": "commonjs" in package.json? But I can't change that to "module" as then running DatoCMS migrations will fail 🤷 .
It's a bit of a non-issue. Astro check shouldn't even lint this file and just stick to src/. But I'm unable to configure that. What I could do as a workaround is in the CI lint job, delete config/datocms/scripts/ before running npm run lint:astro. What do you think?
There was a problem hiding this comment.
patch available as PR: #241
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
The functionality itself is ready. The only issue is a failing Astro check in the CI lint-code job. See comment. I could use some help resolving that issue.
Changes
docs/*.mdfiles.documentation) and uses it as a parent page.Associated issue
Related to #27, though that issue is mainly about seeding required content.
How to test
npm run seed:docs(you may want to switch to a new sandbox environment for this)./datocms-environment.ts)Checklist
I have added a decision log entry if the change affects the architecture or changes a significant technology