search

EmilStenstrom / django-components

Create simple reusable template components in Django.
MIT License
1.16k stars 76 forks source link

Move documentation to GitHub Pages #401

Closed EmilStenstrom closed 2 months ago

EmilStenstrom commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

@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.

EmilStenstrom commented 5 months ago

@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?

dalito commented 2 months ago

Maybe add an additional link to the docs in the "About" section of the gh project page? - Ok the code is only merged but the page is not yet up. So I was too early to ask...

EmilStenstrom commented 2 months ago

@dalito Yes, when we get this working (this is my first time fiddling with this) we'll make sure it's replacing the current mega-README :)