search

Sebobo / Shel.Blog

A simple blog based on Fusion and Yaml configurations without PHP requirements
MIT License
12 stars 14 forks source link

Enhance documentation for beginners #21

Open alexander-nitsche opened 1 year ago

alexander-nitsche commented 1 year ago

To introduce Neos or blog newbies to your package, it might be worth improving these parts:

  1. What is the basic structure / relation between entities from top to bottom? One latest entries content element shows many feeds, a feed has many articles, and an article has many content elements? One feed can show one to many categories, and one article can be associated with many categories?

  2. What would the structure and code (including file paths) look like in practice for

    a. a minimal HTML example (one latest entries content element lists one blog article and redirects to a single view of the article), b. a full HTML/Atom example?

    related to popular kickstarter packages like

    c. Neos.Demo and d. CodeQ.Site (at least this is where i landed when reading into the official Neos docs)

    including links to their respective repositories or packagist URLs.

  3. Unify the wording of the entities: Element, entry, article ... Maybe in the end there should be only category, feed, article and content element, where article is a document node and content element is a content node?

  4. What do the final blog URLs look like in the examples from above?

Maybe it's just because I'm new to Neos and feeds as an organizational structure in the blog context (and not just as an additional invisible Atom feed in the background), but I wanted to mention it here.

Sebobo commented 1 year ago

Thx for the notes!

I had built this package as one of my first Neos plugins back in 2014 I think, so much has changed over the years.

You probably saw my branch feature/rewrite in which I try to step by step put the whole thing on a more modern approach.

My goal is to have an underlying system of integration components and helpers that take away all the tedious work of getting all the listing, pagination, caching, SEO, etc. work properly done and then have presentational components that make it very easy to be overridden in your project.

Would you be interested in reviewing and discussing my approaches when I'm a bit further? I'll also try a bit to keep a documentation more in my during my work as it might make some decisions easier if I try to explain them at the same time 😉

alexander-nitsche commented 1 year ago

Hi Sebastian, sure, i will add notes where i can. Greetings, Alex