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.

Sign up for GitHub

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

Jump to bottom

Make our project website more public-facing. #230

Closed
4 tasks done
samcunliffe opened this issue Feb 16, 2023 · 2 comments · Fixed by #265
Closed
4 tasks done

Make our project website more public-facing. #230

samcunliffe opened this issue Feb 16, 2023 · 2 comments · Fixed by #265
Assignees
@samcunliffe
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority:3
Milestone
End of ARC project.

Comments

@samcunliffe
Copy link
Member

samcunliffe commented Feb 16, 2023 •
edited
Loading

Following a discussion with @prmunro last week, it'd be good to have a welcoming friendly project website.
Currently, our site (https://github-pages.ucl.ac.uk/TDMS) contains only developer docs and redirects new users to the README.md in the repository.

With doxygen, it's possible to include multiple markdown files which get put in the "Related pages" and included as part of the index...

# 'mainpage' gets put on the index page
INPUT += README.md
INPUT += CONTRIBUTING.md
INPUT += doc/developers.md
USE_MDFILE_AS_MAINPAGE = README.md

Results in:
Screenshot 2023-02-16 at 15 15 30

(I.e. contributor guidelines then developer docs (in the order that we'd want because we're lucky with the alphabet).

TODO

  • Make README.md → CONTRIBUTING.md → doc/developers.md flow nicely together (they repeat a bit).
  • Go over README.md and check for clarity.
  • Display department logos and funding agencies?
  • A logo for the web page, or a nice image of light on a sphere, or both.
@samcunliffe samcunliffe self-assigned this Feb 16, 2023
@samcunliffe samcunliffe added priority:3 documentation Improvements or additions to documentation enhancement New feature or request labels Feb 16, 2023
@samcunliffe samcunliffe mentioned this issue Feb 16, 2023
Merged
@samcunliffe
Copy link
Member Author

Still some things to iron out. Playing over on my personal fork of TDMS so as to not break our actual live pages.

@samcunliffe samcunliffe added this to the End of ARC project. milestone Feb 23, 2023
@willGraham01
Copy link
Collaborator

willGraham01 commented Mar 28, 2023 •
edited
Loading

Possibly add a note/request to the end of the readme: (from 28/3/2023 meeting)
If you use TDMS frequently and have example use cases that you don't mind/would like to share, please get in touch at <foobar>.

Peter was keen to keep tabs on potential users, and this is quite a common thing to see on other large projects.

@willGraham01 willGraham01 mentioned this issue Mar 28, 2023
Merged
@samcunliffe samcunliffe mentioned this issue Apr 17, 2023
Merged
samcunliffe added a commit that referenced this issue Apr 20, 2023
@samcunliffe
Resolves the final parts of #230.
195c7dc 
Clean up the flow of information from README → CONTRIBUTING →
doc/developers.
* Remove repetition of information particularly in developers docs.
* Simplify the language in README (with assistance from ChatGPT!)
* Move some of the guidelines in CONTRIBUTING into templates for PRs, bug
  reports and feature requests and then just reference the templates.
* Other grammar and consistency tweaks.
@samcunliffe samcunliffe mentioned this issue Apr 20, 2023
Merged
1 task
samcunliffe added a commit that referenced this issue Apr 24, 2023
@samcunliffe @willGraham01
Final part of #230: clarity + the flow of information (#265)
722d461 
* Merge squash origin/update-readme.

* Resolves the final parts of #230.

Clean up the flow of information from README → CONTRIBUTING →
doc/developers.
* Remove repetition of information particularly in developers docs.
* Simplify the language in README (with assistance from ChatGPT!)
* Move some of the guidelines in CONTRIBUTING into templates for PRs, bug
  reports and feature requests and then just reference the templates.
* Other grammar and consistency tweaks.

* Suggestions from code review

Tweaks, clarity, and avoid repeating words and clarity.

Co-authored-by: Will Graham <[email protected]>

---------

Co-authored-by: Will Graham <[email protected]>
@samcunliffe samcunliffe mentioned this issue Apr 24, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samcunliffe samcunliffe

Labels
documentation Improvements or additions to documentation enhancement New feature or request priority:3
Projects
None yet
Milestone
End of ARC project.
Development

Successfully merging a pull request may close this issue.

Final part of #230: clarity + the flow of information UCL/TDMS
2 participants
@samcunliffe @willGraham01