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.

Sign up for GitHub

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

Jump to bottom

feat: restructure typedoc directories to support the docs hub #1155

Merged
merged 11 commits into from
Aug 2, 2023
Merged

feat: restructure typedoc directories to support the docs hub #1155

merged 11 commits into from
Aug 2, 2023

Conversation

danielbate
Copy link
Contributor

@danielbate danielbate commented Jul 31, 2023 •
edited
Loading

As part of the work being conducted in #835, in order to support integration with the docs hub and generate a better doc structure with more semantic links, we should alter and restructure the files generated by typedoc. This PR will also auto generate the links generated by typedoc.

@danielbate danielbate marked this pull request as ready for review August 1, 2023 17:14
camsjams
camsjams previously approved these changes Aug 1, 2023
View reviewed changes
Copy link
Contributor

@camsjams camsjams left a comment

Choose a reason for hiding this comment

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

👍

arboleya
arboleya requested changes Aug 1, 2023
View reviewed changes
Copy link
Member

@arboleya arboleya left a comment

Choose a reason for hiding this comment

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

The build is failing with:

[vitepress] One or more pages contain dead links.

Probably something with the Address class (it shows empty):

address

Note
Left is my local env, fright is the published version.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023 •
edited
Loading

Coverage report

St.❔
 Category Percentage Covered / Total
🟢 Statements 84.74% 4576/5400
🟡 Branches 65.39% 699/1069
🟡 Functions 74.88% 790/1055
🟢 Lines 84.86% 4372/5152

Test suite run success

1123 tests passing in 191 suites.

Report generated by 🧪jest coverage report action from 4229d7d

@danielbate
Copy link
Contributor Author

danielbate commented Aug 2, 2023 •
edited
Loading

@arboleya ah apologies, I've simplified it now`. This commit has resolved :)

@danielbate danielbate enabled auto-merge (squash) August 2, 2023 08:36
arboleya
arboleya approved these changes Aug 2, 2023
View reviewed changes
Copy link
Member

@arboleya arboleya left a comment

Choose a reason for hiding this comment

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

⚡

@danielbate danielbate merged commit b3d6d52 into master Aug 2, 2023
8 checks passed
@danielbate danielbate deleted the db/feat/restructure-typedoc-directories branch August 2, 2023 23:26
@danielbate danielbate mentioned this pull request Aug 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarahschwartz sarahschwartz sarahschwartz approved these changes

@arboleya arboleya arboleya approved these changes

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10 Dhaiwat10 is a code owner

@nedsalk nedsalk Awaiting requested review from nedsalk nedsalk is a code owner

@camsjams camsjams Awaiting requested review from camsjams

Assignees

@danielbate danielbate

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@danielbate @arboleya @camsjams @sarahschwartz