loading...

I'll be adding some "language" docs

ben profile image Ben Halpern ・1 min read

We have a pretty lax approach to terms and canonical words for things, so I'll be adding some docs to kick off the "right" way to do things.

Obviously we also need a multi-lingual approach for future iterations, and possibly provide the freedom for communities to customize certain verbs, but we'll benefit from at least having a place to refer to when in doubt.

"Reading list" and "Saved posts" are used somewhat interchangeably, and I think we should unify this. I think "Saved posts" is more flexible and encourages the save action more but we should chat about that.

If we changed to "saved posts" everywhere, we'll need to change the URL, most likely also redirect /readinglist to the new URL.

Any thoughts are welcome.

Discussion

markdown guide
 

Love the idea of "Saved Posts" In the early days of using my first Forem I was confused on what the Reading List was. It wasn't until I clicked on it after saving posts that I realized it was where my saved posts went.

 

The reason it is inconsistent is because I felt early on like Reading List was the right word for the place the stuff landed and the "bookmark" icon made more sense than other "save" icons, but that "save" seemed like a slightly more action-oriented and simple term than anything "bookmark", which isn't obviously associated with "readinglist" anyway.

...... All in all it's kind of an under-developed part of the site and bringing more linguistic and design clarity will likely improve our capacity to write good code and really build out the stability and quality of the feature all around.

 

Add initial language doc page #9653

What type of PR is this? (check all applicable)

  • [ ] Refactor
  • [ ] Feature
  • [ ] Bug Fix
  • [ ] Optimization
  • [x] Documentation Update

Description

This is a page to better describe some language concepts in the site. We currently do not have a good canonical location here. This is a first pass to be updated continuously. It is not complete, if you have more to add, let's merge this and keep adding to this and other docs.

 

Regarding the "multilingual" aspect. If the URL is designed to mean something then it should be localized too.

/readinglist
/listedelecture
etc.