FE part of BE issue 1586 provide index md

• I added an index.md which will be the landing page for the docs. It has an explanation of Pleroma-FE from the user point of view
• See also BE MR: pleroma!2669 (merged)
• And issue: pleroma#1586 (closed)

shouldn't index.md have links to user guide, hacking and customization files?

so far it looks like it's retelling what's already in USER_GUIDE

shouldn't index.md have links to user guide, hacking and customization files?

No, these are visible on the left side of the page because that's how mkdocs builds them. See [1] for a screenshot of how it looks if you choose "Frontend" from the tabs.

so far it looks like it's retelling what's already in USER_GUIDE

Huh, indeed. I copied the FE part that I removed from the BE docs, but you are correct, this should be merged with the user guide somehow. I'll see how I can do this best (prob wont be this week or weekend any more, though)

[1]

That's why I asked if it's should contain links to different pages, because there are 3 different kind of documentations - for users, for admins and for contributors/enthusiasts.

IMO the landing page should have brief description (which mostly already there) and three big links something like.

I'm a user, and I need help! ----> user guide
I'm an admin, how do I make it more unique? ----> customization
I want to contribute or pick pleroma-fe apart and back together, how do I start? ----> hacking

added 1 commit

• e22e5330 - Only general description on index page

Compare with previous version

This is how it looks now when clicking the "Frontend" tab. I took part of the description of the user guide and removed it there. I didn't merge the whole block of extra explanation because I'm afraid it will be too much work for now and it probably deserves a whole new MR

looks good to me

mentioned in commit 7bd89b57

merged

mentioned in issue pleroma#1586 (closed)