I'm finally getting around to making that FAQ

[David Alayachew]

Hello Amber Dev Team,

I am finally getting around to making that FAQ that we have all been
talking about but not doing anything about for a few years. Just wanted to
go over structure.

(Of course, in the name of actually getting a pull request through so that
we can get something DONE, I won't wait for responses before committing.)


   1. I'm going to post the FAQ on the amber-docs github --
   https://github.com/openjdk/amber-docs.
      1. This just makes sense -- want to learn about Amber? Go to the
      amber docs. FAQ is a very reasonable thing to have on there imo.
   2. I am going to have an *INDIVIDUAL FAQ* for each JEP.
      1. Obviously, only the "final" JEP's. None of the preview ones. The
      amber-docs already organized this way, so it will be easy to
just add onto
      it.
      2. I expect push back on the "FAQ for each feature" idea, and I can
      be convinced otherwise. Shuffling around answers back and forth is low
      effort too, so this won't be an issue if I need to undo my work.
But, this
      just makes things easier, IMO.
      3. Plus, precedent was set with Local Variable Type Inference. It has
      its own FAQ, so might be wise to emulate IMO.
   3. I will only post summarized questions and summarized answers, with
   links to the original answers.
      1. For summarized questions, I don't have a super strict definition
      for this. I am basically going to try and group together questions into
      meaningfully distinct groups, then summarize for each group.
      2. The answers, however, will be *nothing but pure quotes* of the
      original answer. I might "String [...] parts of [...] the same
quote [...]
      together", but I'll act in good faith to try and retain the intent. And
      either way, the link is right there, and this is an open source
repo. Make
      a PR if you all think I get it wrong.
   4. I will limit answers to only those given by direct members of the
   Amber Dev Team, and only for answers given on this mailing list or
   StackOverflow.
      1. The list of members can be found here --
      https://openjdk.org/census#amber
      2. The reason for limiting to only those 2 sites is to avoid
      link-rot, where a post is deleted, thus, removing the question
that one of
      these answers is for. It's important to be able to see the original
      question that the answer is responding too. No question summary
that I make
      will be able to fully capture the nuance of each question.

I will be focusing on doing this nice and sweet and slow. I'll make it a
goal to add 1 or 2 entries every week at a minimum. Consistency is key
here. No duds or half-finished work.

And finally, once the general structure is in place and people have more or
less settled on a design, please feel free to jump in. As answers get given
to common questions, make a PR to index them here. it's a hell of a lot
easier to index an answer given days ago as opposed to trying to dig
through the mailing list archives from years ago lol.

Thank you for your time and consideration.
David Alayachew
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/amber-dev/attachments/20250316/f91bbb22/attachment-0001.htm>