Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add background and about docs #217

Merged
merged 4 commits into from
Dec 5, 2024
Merged

Add background and about docs #217

merged 4 commits into from
Dec 5, 2024

Conversation

choldgraf
Copy link
Member

This PR adds a bit of background information to this project, and updates the docs a little bit in general. The goal is to provide high-level motivation and context for our goals and why the project exists. Here are the main additions:

  • Added an "About FRX" page that describes the key ideas behind the paper and where this project tries to fit in. This is heavily inspired by the discussion @yuvipanda led in Pick a name for this open source project #15
  • Added some ideas for the functionality and goals of the project at a high level
  • Updated README.md so that we re-use it as the landing page for the website as well
  • Some minor website updates

I decided to write this up as a way of helping me learn more about the motivation behind the project in general, so hopefully these ideas are correct and helpful to others!

This likely feeds into the following issues:

docs/frx.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/frx.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
choldgraf and others added 2 commits December 4, 2024 15:01
@choldgraf
Copy link
Member Author

I made a few updates to your comments and committed - lemme know if that looks OK! And feel free to merge if you or others want to.

@yuvipanda yuvipanda merged commit b96c2a5 into main Dec 5, 2024
1 check passed
@yuvipanda yuvipanda deleted the docs-explain branch December 5, 2024 00:10
@yuvipanda
Copy link
Member

ty @choldgraf

@choldgraf
Copy link
Member Author

Is there a reason not to talk about this project? Eg just throwing excitement towards it on social media or informal conversation? I know we are planning to "launch" it formally but I'm a fan of communication throughout the process rather than waiting until the end. What do others think?

Note that we absolutely still would need to write up the big post etc, I am just talking about informal comms leading up to it

@yuvipanda
Copy link
Member

@choldgraf mostly that there is no real documentation, so if people come see there isn't much to be seen. Not a secret or anything like that though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants