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

Update documentation throughout repo #921

Open
spwoodcock opened this issue Oct 18, 2023 · 3 comments · Fixed by #2061
Open

Update documentation throughout repo #921

spwoodcock opened this issue Oct 18, 2023 · 3 comments · Fixed by #2061
Labels
docs Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers priority:high Should be addressed as a priority

Comments

@spwoodcock
Copy link
Member

spwoodcock commented Oct 18, 2023

Replacement of #164

We currently have some minimal documentation, which could be greatly improved.
We would really welcome PRs for this 🙏

What needs to be done:

  • Proof reading of current docs and correction.
  • Reduce docs duplication - we currently have the same content duplicated in a few places.
  • Improve general README, contributors guidelines, etc.
  • Improve developer documentation with additional examples, FAQs (if you struggled setting up FMTM anywhere, feel free to document it!).
  • Improve user documentation for how to use FMTM.
  • Python docstrings throughout the backend, where missing (especially on routes).
  • If you particularly like writing JSDoc docstrings, then it wouldn't harm having a few in the frontend too.
@spwoodcock spwoodcock added docs Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers priority:high Should be addressed as a priority Epic labels Oct 18, 2023
@vinayakhegde1
Copy link

@spwoodcock I've imrpoved the contributing guidelines please do check

@spwoodcock spwoodcock removed the Epic label Jan 21, 2024
@spwoodcock spwoodcock pinned this issue Jul 5, 2024
manjitapandey added a commit that referenced this issue Oct 9, 2024
Updated the project creation video and images
#921 

Signed-off-by: Manjita Pandey <[email protected]>
@manjitapandey manjitapandey mentioned this issue Dec 20, 2024
7 tasks
@spwoodcock spwoodcock reopened this Jan 8, 2025
@spwoodcock
Copy link
Member Author

spwoodcock commented Jan 8, 2025

Reopening as a more general issue for contributors to help on.

It could definitely be split into sub issues based on the description though, to make it clearer what needs to be done

@manjitapandey
Copy link
Contributor

Agreed, Sorry I mistakely closed it adding fixes and this issue. Not intended.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers priority:high Should be addressed as a priority
Projects
Status: In Progress
4 participants