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

Define and document project domain terms and concepts #18

Open
mscottford opened this issue Oct 14, 2022 · 1 comment
Open

Define and document project domain terms and concepts #18

mscottford opened this issue Oct 14, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mscottford
Copy link
Member

mscottford commented Oct 14, 2022

We have created a bunch of different terms and concepts in this project, but we're not always using them correctly. We also don't have a place for new folks to look to get up-to-speed with the project. Documenting these things in a .md file in the docs/ directory would help with that.

Once we have these terms defined, we can also open up separate issues wherever we see places in the code where the wrong names are being used.

@mscottford
Copy link
Member Author

This issue was inspired by a recent Twitter exchange: https://twitter.com/Felienne/status/1580870136247902210

@mscottford mscottford added this to the v0.6.0 milestone Jul 17, 2023
@mscottford mscottford transferred this issue from corgibytes/freshli-cli Aug 18, 2023
@mscottford mscottford modified the milestones: v0.6.0, v0.8.0 Sep 18, 2023
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
Status: To Do
Development

No branches or pull requests

1 participant