๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป Condenser: Documenting Steemit.com File Structure

in Steem Dev โ€ข 2 months ago

As you'll see from the images below, this took a monumental effort so if somebody would like to check that it's correct, I would appreciate it ๐Ÿ˜‰

Steemit.com's main content areas are all stored within the /src/app/components directory and split into 4 folders:

  • /pages
  • /modules
  • /cards
  • /elements

I've ordered the folders above in what I believe to be the predominant hierarchy, with elements generally being the smallest components which build up cards, which build up modules which construct pages.

There are numerous exceptions to this hierarchy where an element is included directly into a page and modules are included within elements, amongst others but in the main, the hierarchy holds true.


I had initially planned to produce one document to display all of this but once I started including the elements, this proved unwieldy so I have produced a document for each folder. It might be useful as I work on the files, to include a complete document for the page that I'm working on but we'll see how it goes.

In each of the diagrams below, where an element/card/module/page is used in more than one file, I have colour coded it in the hope that it will be more easily identified where it's used. With elements, this won't be as easy as it will be with other documents.

If the text is in grey, it means that the file exists but does not appear to be being used.

You can click on each image to load the full sized version.


๐Ÿ— Pages

โจŠ Modules

๐Ÿƒ Cards

๐ŸŒ๐Ÿ’ฆ๐Ÿ’จ๐Ÿ”ฅ Elements

This documentation completes the end of Stage 1:

(a) โœ… CSS File Structure - Identify what CSS Files there are, document their hierarchy and where they're imported.

(b) โœ… Sitemap - Identify all of the pages that are present on steemit.com.

(c) โœ… JavaScript File Structure - this will look at each of the cards, elements, modules and pages to see where each component is used to produce a file hierarchy.

Separator-code.png

In my sitemap documentation post, I suggested that the next step should be to introduce a navigation bar into the Feeds area - to allow users to remove the need for the left sidebar, to allow users to more easily switch between Feeds and Profile and provide a clearer "Location" within steemit.com.

The feedback on this idea was positive so I believe it makes sense to focus on this before implementing an improved design - the proposed design would benefit from the removal of left or right sidebar so this piece of work precedes it.

My intention is to be consistent with the design used in the Profile area and introduce menu items:

  • All posts
  • Announcements
  • My Friends
  • My Communities

image.png

Since the information of what I'll work on next is somewhat hidden at the end of this post, I'll write another update in a few days time which will include an intended design.

Sort: ย 
ย 2 months agoย 

You've really put a lot of work into this. I hope the overview helps you for your further tasks.

I am probably right in assuming that you have also stored the overviews in a different file format or that the data are in a raw format. As an image file, you can't really do much with it (except for visualisation on the Steem).
The advantages of the simple search for elements and the simple modification are rather difficult to realise with image files.

ย 2 months agoย 

I used an online tool called Gloomaps to create them... I would share the URL but it would mean that others have editing permission so I probably shouldn't do that ๐Ÿ™‚

Other options for export are PDF or XML format - to search, PDF might be the easiest to see what's happening so I'll add a link to each PDF file in the respective posts. It'll take me a little while but I'll do that now.

The arduous task of figuring out the structure. Great work!

ย 2 months agoย 

Thank you and yes, it was somewhat arduous! I'm enjoying being in the design and code now ๐Ÿ™‚

I don't even see where someone can submit a proposal?

ย 2 months agoย 

Iโ€™ll reply properly on Tuesday as Iโ€™m away for a couple of days. I used a different site to submit the proposal. Iโ€™ll need to check what it was and I changed my keys straight after since it was a site that was built by a user now on Hive. It cost 10 SBD to submit. It was something like steemproposals.com.

Ok, if I submit through that I think I still have Steem Keychain installed on one computer and I will see if that will still work so it will shield my keys. Thanks. Makes it more expensive since SBD is pumped to $4.85

ย 2 months agoย 

Iโ€™m paranoid when it comes to keys so even with keychain Iโ€™d be tempted to change them!

It might be worth running your idea past a couple of witnesses before submitting it to get an indication if theyโ€™ll support it. I know thereโ€™s been a lot of discussion behind the scenes about mine (and the DAO in general) which got mine to where it is.

SBD was around $4 when I submitted mine - Iโ€™d been thinking and talking about doing it for a long time so decided to risk it and the riskโ€™s been worth it!

I'm glad to see yours got passed and the fact we are utilizing the DAO again. Personally mine is a wildcard and I'm going to submit a similar thing on Blurt and HIVE as well. All three platforms could all benefit from this promotion. I will probably take my chances with it and try to get it approved.
I know what you mean when it comes to the keys as well. I always worry about something getting compromised as well. Currently I don't have a ton stacked in any of these platforms but what I usually do is rotate some into them later in the cycle when prices have gone up on these and then I'm able to earn more yield.

ย 2 months agoย 

I look forward to seeing what you've got in mind ๐Ÿ‘๐Ÿผ

Good progress๐Ÿ‘

ย 2 months agoย 

Thanks ๐Ÿ‘

TEAM 1

Congratulations! This post has been upvoted through steemcurator04. We support quality posts , good comments anywhere and any tags.
Curated by : @o1eh



ย 2 months agoย 

Thank you as always @o1eh ๐Ÿ‘

This post has been featured in the latest edition of Steem News...

Coin Marketplace

STEEM 0.28
TRX 0.12
JST 0.034
BTC 63956.43
ETH 3320.30
USDT 1.00
SBD 3.92