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

Remove the Kedro architecture page from the documentation #2368

Closed
stichbury opened this issue Feb 27, 2023 · 2 comments
Closed

Remove the Kedro architecture page from the documentation #2368

stichbury opened this issue Feb 27, 2023 · 2 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

I don't see that the Kedro architecture page has much that is useful to contribute. It has less than 3000 page views in a year and I don't really know what it is documenting.

It may be that we need a way to illustrate the overall system, and perhaps a mermaid graphic (and then a reorganisation of the docs to reflect that graphic) would be a good way to do it. However, I don't see what we have as valuable and suggest that we remove it. Maybe we could write a blog post about the architecture of Kedro at a later stage.

@astrojuanlu
Copy link
Member

astrojuanlu commented Feb 27, 2023

I think we should put this, and possibly other pages, in a Developers Documentation site, that is more for contributors (even for ourselves). This is what we did at RtD, see https://docs.readthedocs.io/ vs https://dev.readthedocs.io/ (and discussion at readthedocs/readthedocs.org#8751)

@astrojuanlu
Copy link
Member

(Alternatively we could opt for something completely different for the dev docs, for example using the GitHub wiki)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants