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

2024 01 17 new features readme layout and content #130

Merged
merged 25 commits into from
Jan 17, 2024

Conversation

christophercameron-ixd
Copy link
Contributor

@christophercameron-ixd christophercameron-ixd commented Jan 17, 2024

PR Checklist

  • Set yourself as the Assignee
  • Tag anyone you would like to review, or @forms-design or @forms-devs
  • Fill in the template below

What

  • added a new README.md to the /design directory to add a little explanation of what it is for and how we use it
  • updated the /features/README.md file to remove mention of not testing them in the prototype (because we have for some), and added links and descriptions for all the features we have documented
  • changed the prototype-tested.md file names for the prototype version to README.md so the content displays if the user goes to a version directory
  • removed a random .DS... file
  • removed unused feature-template and prototype-version templates, we can just reuse existing directories and files to start from

How to review

  1. Semantic: Do you agree with the changes?
  2. Syntactic: Spelling, grammar, etc.
  3. Have I missed any other unnecessary files?

Who can review

Anyone in the team can review, especially as most of it is file renames and removals.
But content review of the new design/README.md and updated content of the features/README.md would be welcomed!

@christophercameron-ixd christophercameron-ixd added the documentation Improvements or additions to documentation label Jan 17, 2024
Copy link
Contributor

@C-Harry C-Harry left a comment

Choose a reason for hiding this comment

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

Looking good I think!

@C-Harry C-Harry merged commit e8adf94 into main Jan 17, 2024
@C-Harry C-Harry deleted the 2024-01-17-New-features-README-layout-and-content branch January 17, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants