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.

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

Generate API docs for Standard.Base #12203

Merged
merged 3 commits into from
Feb 4, 2025

Conversation

Akirathan
Copy link
Member

@Akirathan Akirathan commented Jan 31, 2025

Follow-up of #12175. Part of #10507.

Pull Request Description

Just generate signature files for Standard.Base with:

sbt:enso> runEngineDistribution --docs api --in-project distribution/lib/Standard/Base/0.0.0-dev

Important Notes

Just adds a bunch of markdown files inside distribution/lib/Standard/Base/0.0.0-dev/docs/api directory.

I will create a new job in an upcoming PR that will compare Standard.Base signatures on every PR with all these markdown files.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    TypeScript,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • Unit tests have been written where possible.
  • If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
    or the Snowflake database integration, a run of the Extra Tests has been scheduled.
    • If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

@Akirathan Akirathan added the CI: No changelog needed Do not require a changelog entry for this PR. label Jan 31, 2025
@Akirathan Akirathan self-assigned this Jan 31, 2025
Copy link

github-actions bot commented Jan 31, 2025

🧪 Storybook is successfully deployed!

📊 Dashboard:

@Akirathan Akirathan force-pushed the wip/akirathan/10507-generate-stdbase-signatures branch from 5c8ee63 to ccd5c4e Compare February 3, 2025 12:01
@Akirathan Akirathan added the CI: Clean build required CI runners will be cleaned before and after this PR is built. label Feb 3, 2025
@Akirathan Akirathan mentioned this pull request Feb 4, 2025
6 tasks
@Akirathan Akirathan merged commit e38c2b1 into develop Feb 4, 2025
50 of 56 checks passed
@Akirathan Akirathan deleted the wip/akirathan/10507-generate-stdbase-signatures branch February 4, 2025 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI: Clean build required CI runners will be cleaned before and after this PR is built. CI: No changelog needed Do not require a changelog entry for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants