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

feat(docs): Add documentation/gh-pages using Catalyst-CI docs builders and actions. #104

Merged
merged 56 commits into from
Nov 8, 2023
Merged

feat(docs): Add documentation/gh-pages using Catalyst-CI docs builders and actions. #104

merged 56 commits into from
Nov 8, 2023

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Nov 2, 2023

Description

This is a PR for review only until the catalyst-ci docs builders are merged.

This sets up full documentation building.

Still TODO as a separate PR will be publishing the built docs to github pages.

stevenj added 30 commits October 18, 2023 14:34
@stevenj
refactor(gateway): Rename catalyst-voices-backend to the catalyst-gat…
d6affe2 
…eway
@stevenj
docs(gateway): Update readme
d1736b9
@stevenj
refactor(gateway): Move the code into the new directory trees, cleanu…
d966461 
…p inside tree still todo.
@stevenj
refactor(gateway): Basic refactor of the event-db config/data and the…
dd7594a 
… db interface logic
@stevenj
docs(gateway): Initial docs for the crates directory inside catalyst …
e00cc4e 
…gateway
@stevenj
refactor(gateway): Move code out of cat-data-service and put it direc…
ffc2514 
…tly in bin
@stevenj
feat(gateway): first build seems to work, but fails due to WIP refactor
fc63b2f
@stevenj
refactor(gateway): Refactor builds properly to a static executable.
85f369d
@stevenj
refactor(gateway): autofixed lints
0a0ce4f
@stevenj
refactor(gateway): WIP remove lint errors
4163ad4
@stevenj
refactor(gateway): WIP refactoring work to remove lint errors
ff9ed9d
@stevenj
refactor(gateway): Don't panic, return the error, and generalize the …
117d1ae 
…error itself.
@stevenj
refactor(gateway): generalize error response
f07a4d5
@stevenj
docs(gateway): indexing ok here, slice already checked to have values
8e398ab
@stevenj
refactor(gateway): Indexing is safe here, so note it.
ab19189
@stevenj
refactor(gateway): don't panic, return an error. reduce size of funct…
90020db 
…ion by splitting into multiple logical units.
@stevenj
refactor(gateway): Purge metrics from legacy service. Unused and can …
deff8a1 
…panic.
@stevenj
refactor(gateway): remove unused rust files from EventDB directory
d783069
@stevenj
refactor(gateway): remove unused dependencies
1d11b40
@stevenj
docs(gateway): Allow intentional panic for test code
6b0ec08
@stevenj
refactor(gateway): eliminate or notate why unwraps/expect are safe
8807d41
@stevenj
refactor(gateway): All lints are clean and restrictively applied
df7b034
@stevenj
refactor(gateway): remove unused dependencies from workspace cargo file
b2059af
@stevenj
refactor(gateway): restrict visibility of event_db to pub(crate) as i…
3026cda 
…ts fully internalized now.
@stevenj
docs(gateway): root level fully documented
4bd314b
@stevenj
docs(gateway): state fully documented
d044759
@stevenj
docs(gateway): Don't worry about full docs for legacy service.
d460fc6
@stevenj
docs(gateway): Service top level fully documented
32403db
@stevenj
docs(gateway): middleware docs complete
21652a4
@stevenj
docs(gateway): Fully documented the docs part of the service
399dca9
@stevenj stevenj added do not merge yet PR is not ready to be merged yet draft Draft review me PR is ready for review labels Nov 2, 2023
saibatizoku
saibatizoku previously approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@saibatizoku saibatizoku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Mr-Leshiy
Mr-Leshiy requested changes Nov 3, 2023
View reviewed changes
docs/Earthfile Outdated Show resolved Hide resolved
docs/Earthfile Outdated Show resolved Hide resolved
docs/Earthfile Outdated Show resolved Hide resolved
@stevenj stevenj added documentation Pull requests that update a dependency file. and removed draft Draft labels Nov 6, 2023
minikin
minikin previously approved these changes Nov 6, 2023
View reviewed changes
Copy link
Collaborator

@minikin minikin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevenj stevenj changed the title Feat/voices docs feat(docs): Add documentation/gh-pages using Catalyst-CI docs builders and actions. Nov 8, 2023
@stevenj stevenj removed the do not merge yet PR is not ready to be merged yet label Nov 8, 2023
@stevenj stevenj enabled auto-merge (squash) November 8, 2023 08:28
Mr-Leshiy
Mr-Leshiy approved these changes Nov 8, 2023
View reviewed changes
Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevenj stevenj merged commit 8262fbd into main Nov 8, 2023
19 of 20 checks passed
@stevenj stevenj deleted the feat/voices-docs branch November 8, 2023 08:35
@stevenj stevenj restored the feat/voices-docs branch November 8, 2023 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mr-Leshiy Mr-Leshiy Mr-Leshiy approved these changes

@minikin minikin minikin left review comments

@saibatizoku saibatizoku saibatizoku left review comments

@FelipeRosa FelipeRosa Awaiting requested review from FelipeRosa

@cong-or cong-or Awaiting requested review from cong-or

Assignees

@stevenj stevenj

Labels
documentation Pull requests that update a dependency file. review me PR is ready for review
Projects
Catalyst
Archived in project
Milestone
M1: Open Source Setup & Initial Votin...
Development

Successfully merging this pull request may close these issues.
4 participants
@stevenj @saibatizoku @minikin @Mr-Leshiy