Improved docs

[hvitis]

Solves an issue.

Changes:

• List of original URLs with parameters
• Expanded information about creating thread functionality
• Introduction to the main logic - app-initiating-threads is actually a message sending functionality (that have option to be replied to within existing already premade thread.)
• New theme - slate.

TODO:

• Verify docs on local by executing (Mac):

bundle exec middleman build --clean

• Run script to deploy on gh-pages branch by running:

./deploy

from within docs folder.

[tarsil]

You are a machine!! Unfortunately today I have no time to review but I will do it soon. Promise. For what I looked it should be ok as is and a great improvement in so many levels. Love it

[tarsil]

This was my initial review but to be fair I'm on my phone so makes it harder to see the whole spectrum buy besides the docs which I asked, everything should be ok.

I like you uuid approach because I also use it. In the past people were defaulting to id but that is the reason why I also make it available the uuid. Nice one if you caught it 🙂

I will continuing reviewing later if you don't mind as I need my laptop and this weekend is busy but I promise to try it. Next week for sure we have a brand new shinny package with your changes. For sure. Once this is merged I will officially add you as maintainer. What do you say?

You seem to manage this package now better than I do (not in a bad way) as I'm also dealing with Esmerald, Saffier, Databasez and Asyncz.

[tarsil]

Are all this files needed in the repo? Maybe the generate command should be enough? Then on the deployment server once the hook is received, triggers the build of the docs there and publishes. What do you think?

[hvitis]

This is exactly what I was trying to figure out now. I wasn't expecting such a blazing fast review!! I used slate. You can see how it looks like with current changes on my fork here.

Basically there is just one file that changes. All docs is in 1 file called index.html.md so if there is any way to:

1. Install/clone slate in another place.
2. Replace the index.html.md file in slate executable folder
3. Run build command
4. Switch branch to gh-pages and commit build result.

Then we are good. The out of the box deploy script that comes with slate needs .env file and accepts repo-link as origin variable to push the changes to gh-pages branch automatically.

Last commit shows that.

[tarsil]

Not sure why this is needed. Maybe is the generated docs that we can generate via exec command as you shared inside a scripts/scripts.sh in the repo and then on the server once the hook is received.

[hvitis]

Yes, cleanup of slate files should solve all those issues.

[hvitis]

How those changes look right now - forked gh-pages.

@tarsil Maybe logo for the repo&docs page?

[tarsil]

Beautiful!!!!! 😎😎😎😎😎. Way better than before. Evolution. You're a star.

Regarding the logo. Well I built all logos before but not for this one. I can think of something if you want

[hvitis]

Maybe something along this line? Is it too similar? :D

[tarsil]

Actually it's even better than the one I had in mind. Related with DRF and unique. This one is perfect actually

[tarsil]

@hvitis i do really apologise as I thought I already had merged this!! My God, I missed out it this bit.

It has been a hectic few months with a lot going on but I will definitely merge your changes but I will need to update the CI.

It is using an old version and I want to move to GActions.

I could even put you as a maintainer if you want? :)

Once again, I do really apologise.

P.S.: I'm still not sure if all of these files are needed or auto generated

[hvitis]

Hey. Sure. Put me as a maintainer, cancel this PR and put a list of changes you'd like to see implemented. I'll see what I can do!

[tarsil]

So, I didn't mean to disrespect you by thinking i did it before and apparently it was forgotten. So sorry.

What I would say we could start would be:

1. Move away from circle CI and into GitHub actions. I did something like that with Django Tenants URL. This will allow not only to add support for python 3.11 but also remove from 3.7.
2. Your documentation idea is amazing.
3. The same for your logo.
4. Add a workflow to publish a version every time a new tag is created or push to the repo. I can do this one but it will follow the same lines as this one example

You are now a maintainer so you can also improve as you see fit. I'm 100% sure that you now use it more than I do unfortunately. I'm maintaining Esmerald and Edgy and few others which takes majority of my time.

P.S.: You might have received the invite already to join the repo. Feel free to reuse this or simply open a new one. A good plan is ok 👍🏼

[hvitis]

Hey! No worries at all! I was rushing and answering from my mobile. I think the outcome is:

• I will recheck this PR to delete redundant files
• I will merge it and verify the new layout
• I will move to deploying via GH actions and create z separate future PR for it
  Then we will chat! :)

Thanks and let's keep in touch.

[tarsil]

Thank you so much @hvitis i really do appreciate that from you. Just accept the invite.

By the way, you seem someone that likes python a lot and playing around. What if you have a look at Esmerald and tell what do you think? Do you think it is something that it might be of interest of you? Maybe maintainer as well if you like and played around?

[hvitis]

I did accept it now. I have seen your projects but I am mainly working with Django. Maybe a younger audience interested in new frameworks would be a good targets? czw., 31 sie 2023 o 17:23 Tiago Silva ***@***.***> napisał(a):

…

Thank you so much @hvitis <https://github.com/hvitis> i really do appreciate that from you. Just accept the invite. By the way, you seem someone that likes python a lot and playing around. What if you have a look at Esmerald <https://esmerald.dev> and tell what do you think? Do you think it is something that it might be of interest of you? Maybe maintainer as well if you like and played around? — Reply to this email directly, view it on GitHub <#21 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AECP234E4HYKDBGR6YC65CLXYCT7BANCNFSM6AAAAAAXG4PHUA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[tarsil]

I did accept it now. I have seen your projects but I am mainly working with Django. Maybe a younger audience interested in new frameworks would be a good targets? czw., 31 sie 2023 o 17:23 Tiago Silva @.> napisał(a):
…
Thank you so much @hvitis https://github.com/hvitis i really do appreciate that from you. Just accept the invite. By the way, you seem someone that likes python a lot and playing around. What if you have a look at Esmerald https://esmerald.dev and tell what do you think? Do you think it is something that it might be of interest of you? Maybe maintainer as well if you like and played around? — Reply to this email directly, view it on GitHub <#21 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AECP234E4HYKDBGR6YC65CLXYCT7BANCNFSM6AAAAAAXG4PHUA . You are receiving this because you were mentioned.Message ID: @.>

It might be an idea as this is more of an alternative, scalable and simply different :)