Skip to content

Added FAQ and Troubleshooting to README.md - #42

Open
NandagopaRaj wants to merge 1 commit into
tkmfoss:mainfrom
NandagopaRaj:main
Open

NandagopaRaj wants to merge 1 commit into
tkmfoss:mainfrom
NandagopaRaj:main

Conversation

@NandagopaRaj

Copy link
Copy Markdown

Summary

Added a Troubleshooting and FAQ section to the README to help beginners resolve common setup issues.

Related issue

Closes #11

Changes made

  • Added an explanation of why opening the project using file:// may not work.
  • Documented how to start a local server using Python or Node.js.
  • Added instructions for hard-refreshing the browser.
  • Explained where to add new resources in the project.
  • Added troubleshooting steps for local server startup problems.

Testing performed

  • I ran the site locally and tested the change.
  • I checked the browser console for errors.
  • I tested on desktop and mobile widths.
  • Other (please describe): Reviewed the README changes for Markdown formatting and clarity.

Screenshots

Not applicable — this change only updates documentation.

Contributor checklist

  • My change follows the existing code style.
  • I have tested my change locally.
  • I have not committed unrelated files.
  • I have commented my code where non-obvious logic lives.

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.

add-a-troubleshooting-and-faq-section-to-the-readme

1 participant