Skip to content

Fix inconsistencies and improve setup instructions in README#71

Merged
SteveDala merged 2 commits intothoth-tech:mainfrom
jmirchh75:docs/readme-update
Mar 22, 2026
Merged

Fix inconsistencies and improve setup instructions in README#71
SteveDala merged 2 commits intothoth-tech:mainfrom
jmirchh75:docs/readme-update

Conversation

@jmirchh75
Copy link
Copy Markdown
Contributor

@jmirchh75 jmirchh75 commented Mar 19, 2026

Changes

  • Included Dev Container instructions for simplified setup.
  • Corrected folder references (e.g. scrsrc)
  • Improved wording and grammar throughout the README
  • Improved instructions for running the development server using npm run dev
  • Added guidance for installing dependencies using npm install
  • Also added timestamp and author at the bottom of file.

Clarify the contribution workflow and local development steps. Fix folder references and improve guidance for running the site locally with Node.js and npm.
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 19, 2026

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit b4cd97d
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/69bf758d2923be0008c1b966
😎 Deploy Preview https://deploy-preview-71--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Collaborator

@SteveDala SteveDala left a comment

Choose a reason for hiding this comment

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

Good changes, but please point new contributors towards the Docker development container for this project.

@SteveDala SteveDala merged commit be7a79c into thoth-tech:main Mar 22, 2026
5 checks passed
@SteveDala
Copy link
Copy Markdown
Collaborator

Done, thanks @jmirchh75!

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.

2 participants