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

Move config from Rails to SDoc #333

Open
p8 opened this issue Oct 15, 2023 · 4 comments
Open

Move config from Rails to SDoc #333

p8 opened this issue Oct 15, 2023 · 4 comments

Comments

@p8
Copy link
Member

p8 commented Oct 15, 2023

Currently generating the API docs is integrated in the Rails project:
https://github.com/rails/rails/blob/main/railties/lib/rails/api/task.rb
This requires the sdoc gem to work with the supported Ruby version of the Rails project and its Gemfile.
If docs generation can be run seperately we can generate the docs for any version of Rails.

@zzak
Copy link
Member

zzak commented Oct 15, 2023

Yeah, this is a known issue but I'm not sure where to put it yet.

@p8
Copy link
Member Author

p8 commented Oct 15, 2023

I think we could have some config file in sdoc where we define the settings for each version of Rails.

@p8
Copy link
Member Author

p8 commented Jan 24, 2024

RDoc supports a .rdoc_options file
We could move a lot of options there.

@zzak
Copy link
Member

zzak commented Nov 1, 2024

Ok, the last issue. I left this because I think it's actually nice backend work we can do without disrupting any UX stuff.

The goal is to have SDoc be able to generate the Rails API docs for any version. So not relying on configuration based in-repo.

This way we can have a single process to build the docs for all (stable) versions of Rails when we deploy, and changes or improvements to the UI will be applied everywhere. That removes the jarring effect of viewing older version of the docs and getting lost (not that I don't love the nostalgia of the old ui).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants