Skip to content

docs(jans-cedarling): improve cedarling docs #11193

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

Merged
merged 7 commits into from
Apr 8, 2025
Merged

Conversation

rmarinn
Copy link
Contributor

@rmarinn rmarinn commented Apr 8, 2025

Prepare


Description

This PR adds a getting started section in the docs.

Target issue

closes #11194

Implementation Details

This PR adds the following .md files:

  • docs/cedarling-getting-started.md
  • docs/getting-started/javascript.md
  • docs/getting-started/python.md
  • docs/getting-started/rust.md
  • docs/getting-started/kotlin.md
  • docs/getting-started/swift.md

The "Getting Started" should be displayed before the "Overview" section


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

rmarinn added 3 commits April 8, 2025 14:49
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
@rmarinn rmarinn self-assigned this Apr 8, 2025
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-cedarling Touching folder /jans-cedarling labels Apr 8, 2025
@mo-auto
Copy link
Member

mo-auto commented Apr 8, 2025

Error: Hi @rmarinn, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

rmarinn added 2 commits April 8, 2025 17:26
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
@rmarinn rmarinn changed the title docs(jans-cedarling): update cedarling docs docs(jans-cedarling): improve cedarling docs Apr 8, 2025
Signed-off-by: rmarinn <34529290+rmarinn@users.noreply.github.com>
@rmarinn rmarinn requested review from SafinWasi and nynymike April 8, 2025 18:00
@rmarinn rmarinn marked this pull request as ready for review April 8, 2025 18:01
Copy link
Contributor

@nynymike nynymike left a comment

Choose a reason for hiding this comment

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

Let's push changes but this still needs more work.

Copy link
Contributor

@SafinWasi SafinWasi left a comment

Choose a reason for hiding this comment

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

Looks good to me. Regarding interfaces, I documented them here: #11192

@rmarinn rmarinn merged commit 2d74518 into main Apr 8, 2025
2 checks passed
@rmarinn rmarinn deleted the cedarling-docs-update branch April 8, 2025 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-cedarling Touching folder /jans-cedarling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(jans-cedarling): improve cedarling docs
4 participants