Skip to content

feat: doc improvements#1458

Merged
jaime-iobermudez merged 20 commits into
developfrom
feat/doc-improvements
May 6, 2026
Merged

feat: doc improvements#1458
jaime-iobermudez merged 20 commits into
developfrom
feat/doc-improvements

Conversation

@jaime-iobermudez

@jaime-iobermudez jaime-iobermudez commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Description:

This pull request contains several documentation and configuration improvements aimed at clarifying setup steps and ensuring consistency in naming and instructions. The most notable changes include correcting the product name throughout the documentation and updating environment file references to match the actual files in the project.

This PR fixes #1476

Documentation and Naming Consistency:

  • Changed all instances of "Stable Coin Studio" to "Stablecoin Studio" in both the Docusaurus configuration (apps/docs/docusaurus.config.ts) and navbar title to ensure consistent branding. [1] [2]

Setup Instruction Updates:

  • Updated instructions in documentation/gettingStarted/quick-start.md and documentation/web/quick-start.md to use .env.sample instead of .env.example for environment variable setup, reflecting the correct file present in the repository. [1] [2]
  • Clarified that the app should be started from the apps/web directory in the quick start guide for better developer guidance.
  • Added an explicit npm install step before running the documentation site to ensure all dependencies are installed.

Related issue(s):

Fixes #

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
@jaime-iobermudez jaime-iobermudez self-assigned this Apr 8, 2026
@jaime-iobermudez jaime-iobermudez requested review from a team as code owners April 8, 2026 13:47
@swirlds-automation

swirlds-automation commented Apr 8, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Comment thread documentation/gettingStarted/quick-start.md
luigi-io and others added 7 commits April 10, 2026 16:40
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
… tests in the same way as the pipeline

Signed-off-by: Luigi Navarro <luigi@io.builders>

@luigi-io luigi-io left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great job!

Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
@luigi-io luigi-io requested a review from a team as a code owner May 5, 2026 17:13
Signed-off-by: Luigi Navarro <luigi@io.builders>
Signed-off-by: Luigi Navarro <luigi@io.builders>
@sonarqubecloud

sonarqubecloud Bot commented May 5, 2026

Copy link
Copy Markdown

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

@jaime-iobermudez jaime-iobermudez merged commit 4896e37 into develop May 6, 2026
17 of 18 checks passed
@jaime-iobermudez jaime-iobermudez deleted the feat/doc-improvements branch May 6, 2026 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants