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

Add build script alias to generate and open API documentation #114

Merged
merged 4 commits into from
Jul 3, 2024
Merged

Add build script alias to generate and open API documentation #114

merged 4 commits into from
Jul 3, 2024

Conversation

Hermann-Core
Copy link
Collaborator

No description provided.

@Hermann-Core Hermann-Core linked an issue Jul 2, 2024 that may be closed by this pull request
Add build script alias to generate and open API documentation #108
Closed
@Hermann-Core Hermann-Core removed the request for review from IngridPuppet July 3, 2024 07:50
IngridPuppet
IngridPuppet reviewed Jul 3, 2024
View reviewed changes
Copy link
Collaborator

@IngridPuppet IngridPuppet left a comment

Choose a reason for hiding this comment

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

Is the name of this PR even consistent with these changes? It looks more like you're fixing the workspace configuration than providing a script of any kind.

@Hermann-Core
Copy link
Collaborator Author

Is the name of this PR even consistent with these changes? It looks more like you're fixing the workspace configuration than providing a script of any kind.

The build script alias is defined in .cargo/config.toml. Now, by simply typing cargo docs in the terminal, we can generate the entire workspace API documentation and open it. Updates to the workspace manifest have been made to reflect these changes.

IngridPuppet
IngridPuppet requested changes Jul 3, 2024
View reviewed changes
Copy link
Collaborator

@IngridPuppet IngridPuppet left a comment

Choose a reason for hiding this comment

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

My apologies for my previous comment. I read OpenAPI, which you agree, is something completely else 😂😂😂

Please, consider my comments below.

Cargo.toml Outdated Show resolved Hide resolved
Cargo.toml Show resolved Hide resolved
@Hermann-Core Hermann-Core merged commit 3948b15 into main Jul 3, 2024
1 check passed
@Hermann-Core Hermann-Core deleted the feat-108-automate-api-documentation-generation branch July 4, 2024 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IngridPuppet IngridPuppet IngridPuppet approved these changes

@francis-pouatcha francis-pouatcha Awaiting requested review from francis-pouatcha

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add build script alias to generate and open API documentation
2 participants
@Hermann-Core @IngridPuppet