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

begin updating documentation #88

Merged
merged 1 commit into from
Jun 28, 2022
Merged

begin updating documentation #88

merged 1 commit into from
Jun 28, 2022

Conversation

helmturner
Copy link
Collaborator

@helmturner helmturner commented Jun 27, 2022

  • update CONTRIBUTING.md, README.md, and other docs in project root folder
  • add workflow for auto-generating table of contents in markdowndocumentss
  • clarify code comments in src/features/blog/blogdata.ts
  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    Documentation update

  • What is the current behavior? (You can also link to an open issue here)
    Begins to address Update Readme #27 RE: docs outdated due to stack changes

  • What is the new behavior (if this is a feature change)?
    Docs partially updated to reflect recent stack changes

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    May require polishing of table-of-contents workflow introduced in this pr

  • Other information:
    WIP

update CONTRIBUTING.md, README.md, and other docs in project root folder

clarify code comments in src/features/blog/blogdata.ts
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.

Update Readme Roadmap
2 participants