Skip to content

Update FF README #1492

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update FF README #1492

wants to merge 4 commits into from

Conversation

CharlyMartin
Copy link
Collaborator

@CharlyMartin CharlyMartin commented Jun 24, 2025

📝 Description

This PR modifies the README.md with updated instructions.

Open questions:

  1. What should we do about the page generator command? It's broken in its current state. Should we fix it or remove it entirely now that adding new pages is rare?
  2. Should we move the development guidelines to the monorepo README, since they apply to all projects?

Copy link

vercel bot commented Jun 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
filecoin-foundation-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 8:56am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
ffdweb-site ⬜️ Skipped (Inspect) Jun 25, 2025 8:56am
filecoin-foundation-uxit ⬜️ Skipped (Inspect) Jun 25, 2025 8:56am

Copy link

[FF] Update README

@vercel vercel bot temporarily deployed to Preview – filecoin-foundation-uxit June 24, 2025 09:35 Inactive
@vercel vercel bot temporarily deployed to Preview – ffdweb-site June 24, 2025 09:35 Inactive
@CharlyMartin CharlyMartin changed the title Update README.md for clarity and organization Update FF README Jun 24, 2025
@CharlyMartin CharlyMartin marked this pull request as ready for review June 24, 2025 09:37
Copy link
Collaborator

@barbaraperic barbaraperic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 😊 Left a few comments

@@ -74,12 +25,12 @@ Decap CMS is a Git-based content management system, meaning that content is mana

All the content managed through Decap CMS is stored in `src/app/content/`. This directory includes various Markdown files that the CMS edits. Each file represents a different section or page of the website, structured for easy editing and updates.

### Decap CMS Configuration
### Configuration

The Decap CMS setup includes two configuration files:

1. `public/admin/config.yml` - This file primarily contains the schema and metadata for the content but also includes authentication settings among other things.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I understand the "authentication settings" part?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback @barbaraperic. I updated the section, does it make more sense to you now? If not, feel free to edit to your liking.

Comment on lines +146 to +147
<!-- Should we keep it? -->

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With Claude/ChatGPT fixing the script should be quick - but it is one of those things that need maintaining... @mirhamasala thoughts on keeping it or we get rid of it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should remove it from FF and move to a shared package in preparation for filecoin.io, where we'll be creating pages regularly soon?

Co-authored-by: Barbara Peric <50910606+barbaraperic@users.noreply.github.com>
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