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

code documentation #5628

Merged
merged 41 commits into from
Dec 13, 2024
Merged

code documentation #5628

merged 41 commits into from
Dec 13, 2024

Conversation

hexylena
Copy link
Member

@hexylena hexylena commented Dec 10, 2024

small goodbye present from me, since I'm the primary (only) ruby code maintainer.

  • adds RDoc for lint.rb
  • uses that RDoc + our deployed rdoc to replace the poorly maintained wiki we were using for the same (see GTN matrix channel message from Katherine), wiki is disabled.
  • fixes longstanding issue with parsing markdown files for the 'bad header' issue. It is now replaced with kramdown to properly parse the file.
  • adds some Architectural Decision Records for some of our architecture choices that have been brought up recently (jekyll, why images in git)
  • improves video page (/videos/ and /videos/watch.html)
  • moves author pages (Hall of fame) to development env
  • moves API, by-tag to production only (they were before but they're again now.)

Updated Linting Docs

Linting comments will now point to the GTN RDoc with the explanations kept in sync with the code:

Screenshot 2024-12-12 at 18-35-37 module Gtn Linter - RDoc Documentation

Helpful Jekyll Internal Documentation

Specific to us

Screenshot 2024-12-12 at 18-36-01 module Jekyll Generators - RDoc Documentation

Improved Overall Docs

Screenshot 2024-12-12 at 18-36-41 module Gtn TopicFilter - RDoc Documentation

@hexylena hexylena marked this pull request as ready for review December 12, 2024 17:29
@hexylena hexylena requested review from a team, bebatut and shiltemann as code owners December 12, 2024 17:29
@hexylena
Copy link
Member Author

not necessarily ready for review, but ready for tests to execute.

@hexylena hexylena requested a review from a team as a code owner December 12, 2024 17:40
@github-actions github-actions bot added the admin label Dec 12, 2024
@shiltemann
Copy link
Member

thanks @hexylena !

@shiltemann shiltemann merged commit d68e0df into main Dec 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants