#686 Update project structure and docs for project

[andrewtavis]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• [] I have tested my code with the pytest command as directed in the testing section of the contributing guide

---

Description

Follows #701 and #696 being declined. This PR will restructure the project to make it more modular and then update the docs :)

Related issue

• Closes Scribe-Data markdown and rst documentation check #686

[github-actions]

Thank you for the pull request! 💙🩵

The Scribe-Data team will do our best to address your contribution as soon as we can. The following are some important points:

• Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
• If you're not already a member of our public Matrix community, please consider joining!
  • We'd suggest that you use the Element client as well as Element X for a mobile app
  • Join the General and Data rooms once you're in
• Also consider attending our bi-weekly Saturday developer syncs!
  • Details are shared in the General room on Matrix each Wednesday before the sync
  • It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

[github-actions]

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

• Tests for changes have been written and the pytest, linting and formatting workflows within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

@axif0, this is a refactor I realized that we should do when looking into #701 (closed as I think it's fine that we keep the output directories so the tests can use other directories). We have one failing test on Ubuntu, which maybe you'd have an idea on. Aside from that, could you verify that the modularization makes sense to you and make any suggestions that come to mind?

I'll do the remaining work for #686 here. If you wanted to give another pass of the docs, and commit any changes you think are needed, then that'd also be much appreciated 😊

After this is in I'll focus on #617 and #669 :)

CC @DeleMike 👋

[andrewtavis]

Per discussions in the sync, @DeleMike, the documentation to look at would be:

• The readme
• USAGE.md
• The index of the readthedocs docs

CC @axif0 👋

[andrewtavis]

Would be good if all three of the above files are checked by @DeleMike, @axif0 and I :)

[DeleMike]

will work on it :)

[andrewtavis]

Thanks for the test fix, @axif0! I knew it was something simple like that :) :)

[axif0]

Suggested change

	utils.py
	check.py

[axif0]

Isn't this should be language_isos ? like -

Suggested change

	was_or_were = "was" if len(not_included_isos) == 1 else "were"
	rprint(
	f"[bold green]The following {iso_or_isos} {was_or_were} successfully downloaded: {', '.join(not_included_isos)}[/bold green]"
	)
	iso_or_isos = "iso" if len(language_isos) == 1 else "isos"
	was_or_were = "was" if len(language_isos) == 1 else "were"
	rprint(
	f"[bold green]The following {iso_or_isos} {was_or_were} successfully downloaded: {', '.join(language_isos)}[/bold green]"
	)