Skip to content

Conversation

MarBert
Copy link
Collaborator

@MarBert MarBert commented Jul 15, 2025

List of Changes

Add url parsing metadata generation and documentaion parsing to the sync pipeline

Motivation and Context

needed for the T1 update, in order to have the documentation on S3 bucket already parsed (correct Urls and Reusable content)

How Has This Been Tested?

On localhost you need to download the documentation and place it inside devportal-docs/docs
then you need to create the metadata file on the project root:
ts-node packages/gitbook-docs/src/scripts/generateUrlParsingMetadata.ts or npm run generate-url-parsing-metadata -w gitbook-docs
And then run
ts-node packages/gitbook-docs/src/scripts/parseDocUrlsAndIncludes.ts or npm run parse-docs -w gitbook-docs

Screenshots (if appropriate):

Types of changes

  • Chore (nothing changes by a user perspective)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Copy link

changeset-bot bot commented Jul 15, 2025

🦋 Changeset detected

Latest commit: 722a662

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
gitbook-docs Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@MarBert MarBert changed the title [CAI-453] Add documentation parsing [CAI-453][CAI-454] Add documentation parsing Jul 18, 2025
@MarBert MarBert changed the title [CAI-453][CAI-454] Add documentation parsing [CAI-453][CAI-454] Add parsing metadata generation and documentation parsing Jul 18, 2025
MarBert added 2 commits August 5, 2025 14:37
# Conflicts:
#	apps/nextjs-website/scripts/fetch-docs.sh
#	apps/nextjs-website/scripts/fetch-local-docs.sh
#	apps/nextjs-website/scripts/update-docs-ci.sh
@github-actions github-actions bot removed the website label Aug 5, 2025
@MarBert MarBert requested a review from MarcoPonchia August 5, 2025 12:41
Copy link
Contributor

github-actions bot commented Aug 5, 2025

Branch is not up to date with base branch

@MarBert it seems this Pull Request is not updated with base branch.
Please proceed with a merge or rebase to solve this.

@marcobottaro marcobottaro self-requested a review August 5, 2025 15:06
Copy link
Contributor

github-actions bot commented Aug 5, 2025

Jira Pull Request Link

This Pull Request refers to the following Jira issue CAI-453

@marcobottaro marcobottaro dismissed MarcoPonchia’s stale review August 5, 2025 15:11

All issues have been resolved

@marcobottaro marcobottaro merged commit 6ecfd99 into main Aug 5, 2025
12 checks passed
@marcobottaro marcobottaro deleted the CAI-453-parse-doc branch August 5, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants