Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Update documentation #69

Closed
Cloud7050 opened this issue Oct 16, 2023 · 8 comments
Closed

Update documentation #69

Cloud7050 opened this issue Oct 16, 2023 · 8 comments
Assignees
Labels
critical [Priority] Mission-critical; must be done developer guide Documentation sublabel Documentation [Category] MEDIUM [Workload]
Milestone

Comments

@Cloud7050
Copy link

Cloud7050 commented Oct 16, 2023

V1.2 code changes are now complete. This has caused some parts of the starting AB3 documentation to now be outdated. Let's look for such discrepencies and update them accordingly. That way, they won't be reported as many bugs in the PE dry run.

This is a bit vague, so we may be able to split this into multiple, more specific issues once this has been investigated.

@Cloud7050 Cloud7050 added Documentation [Category] minor [Priority] developer guide Documentation sublabel MEDIUM [Workload] unassigned Need to decide who is assigned this work item labels Oct 16, 2023
@Cloud7050 Cloud7050 added this to the v1.2b milestone Oct 16, 2023
@bwangpj bwangpj self-assigned this Oct 17, 2023
@Cloud7050 Cloud7050 removed the unassigned Need to decide who is assigned this work item label Oct 17, 2023
@Cloud7050
Copy link
Author

As part of this, as identified in #71, we can update the GitHub code links in the DG. They currently point to the seedu repo.

@rayshawntan rayshawntan modified the milestones: v1.2b, v1.3 Oct 20, 2023
@rayshawntan
Copy link

Shifting this to milestone v1.3 as we need to update documentation next.

@Cloud7050 Cloud7050 changed the title Start updating documentation Update documentation Oct 20, 2023
@Cloud7050
Copy link
Author

See also #98.

@Cloud7050
Copy link
Author

Cloud7050 commented Oct 23, 2023

Once we have decided which user stories to implement in our meeting and have converted them to issues, it may be applicable to update the user stories' categorisation.

Edit: Forgot I already filed #93 for this.

@bwangpj
Copy link

bwangpj commented Oct 23, 2023

Developer guide (user stories) and user guide needs to be heavily updated as many parts have become outdated.

@Cloud7050 Cloud7050 added critical [Priority] Mission-critical; must be done and removed minor [Priority] labels Oct 23, 2023
@Cloud7050
Copy link
Author

As part of this, as identified in #71, we can update the GitHub code links in the DG. They currently point to the seedu repo.

This is included in #110.

@Cloud7050
Copy link
Author

#114 included some general updates.

@Cloud7050 Cloud7050 modified the milestones: v1.3, v1.3b Oct 27, 2023
@Cloud7050
Copy link
Author

This has been implemented to some extent. The original idea was to start updating the docs "unofficially" back in v1.2. Now, we can instead refer to issues such as #130, #127, #96, #93, #92.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
critical [Priority] Mission-critical; must be done developer guide Documentation sublabel Documentation [Category] MEDIUM [Workload]
Projects
None yet
Development

No branches or pull requests

3 participants