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 documentation to GitHub Pages #401

Open
EmilStenstrom opened this issue Mar 18, 2024 · 4 comments · May be fixed by #420
Open

Move documentation to GitHub Pages #401

EmilStenstrom opened this issue Mar 18, 2024 · 4 comments · May be fixed by #420
Milestone

Comments

@EmilStenstrom
Copy link
Owner

The README is super-long, so I think it's time to move it out to a separate site, and give it some structure.

I suggest GitHub Pages because it's built in to GitHub already.

@JuroOravec
Copy link
Collaborator

Just a cheeky thought. I reckon some sort of documentation builder would be used for this. But if the website had a custom landing page, or something like that, it'd be cool to build it with Django and Django components. https://github.com/meeb/django-distill can be used to build static sites with Django.

@GabDug
Copy link
Contributor

GabDug commented Mar 24, 2024

As the README is already using Markdown, I would say mkdocs-material may be a good fit. I've been working with mkdocs for a while now, so I can contribute to the setup around Mkdocs setup and its CI if help is wanted :)

@EmilStenstrom
Copy link
Owner Author

@JuroOravec While I like the idea of using the library for it's own documentation, I also like the idea of publishing the docs on GitHub Pages and not have to worry about a separate service/server.

@GabDug That looks really good. Would love to get that structure in place. Though I think a lot of the work will be to split the current readme into logical chunks with good section names.

@GabDug GabDug linked a pull request Apr 1, 2024 that will close this issue
22 tasks
@EmilStenstrom EmilStenstrom added this to the Version 1.0 milestone Apr 12, 2024
@EmilStenstrom
Copy link
Owner Author

@GabDug Did you have any chance to make any more progress on this? I think it would make sense to split this work up into several parts, så that just moving what we have could be one step. During the last weeks the README has changed a lot, so I'm not sure this PR will be easy to rebase. If we start with just a split we can keep iterating on the new version while other work in ongoing?

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

Successfully merging a pull request may close this issue.

3 participants