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

rewrite design.md #142

Open
2 tasks
ericbuckley opened this issue Nov 21, 2024 · 0 comments
Open
2 tasks

rewrite design.md #142

ericbuckley opened this issue Nov 21, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ericbuckley
Copy link
Collaborator

Summary

Rewrite the user guide docs/site/design.md document to have the following 3 subsections; Algorithm, Business Rules and MPI.

Acceptance Criteria

  • Clear and testable conditions for the completion of the task.
  • Another condition that defines task completion.

Details / Tasks

The Algorithm section should talk in detail about link.py and how the 3 pass (blocking, evaluation and clustering) steps work together to determine the results of a linkage request.

The Business rules section should talk about the high level differences in what a user can configure vs what is set by code. This doesn't need to list all the options available to them (we can just link to the reference.md), it should just explain the differences.

The MPI is more or less what is already that document, and should explain the database schema design and how it works with the above two sections.

@ericbuckley ericbuckley added the documentation Improvements or additions to documentation label Nov 21, 2024
@ericbuckley ericbuckley self-assigned this Dec 5, 2024
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

No branches or pull requests

1 participant