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

Add valid data table and sample for editing data file in user guide #262

Merged
merged 9 commits into from
Apr 15, 2024

Conversation

tsulim
Copy link
Collaborator

@tsulim tsulim commented Apr 14, 2024

Closes #252

As of now, there are no guide or sample on the format of the data file to follow, except for the generated data file during the first run of the application (which may be cleared by users). This will allow them to learn about the format and values required for amending the data file, reducing errors made in manually editing the data file.

Changes made:

  • Add "Valid Data Values in persons" table
  • Add "Valid Data Values in meetings" table
  • Add "Sample Data File Content"
  • Add note for Favourite and duplicates

@tsulim tsulim added the type.Documentation Improvements or additions to documentation label Apr 14, 2024
@tsulim tsulim added this to the v1.4 milestone Apr 14, 2024
@tsulim tsulim self-assigned this Apr 14, 2024
Copy link
Collaborator

@iynixil iynixil left a comment

Choose a reason for hiding this comment

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

lgtm! suggestion given

docs/UserGuide.md Outdated Show resolved Hide resolved
@iynixil iynixil merged commit 2e900c5 into AY2324S2-CS2103-F08-3:master Apr 15, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add valid values and sample for editing data file in user guide
2 participants