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.

Sign up for GitHub

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

Jump to bottom

Update readme #85

Merged
merged 2 commits into from
Dec 6, 2023
Merged

Update readme #85

merged 2 commits into from
Dec 6, 2023

Conversation

mohamedsalem401
Copy link
Contributor

  • Add discord link
  • Explain how to add Custom fields
  • Explain how to add Configuration

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 5, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: a25b87c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@olayway olayway mentioned this pull request Dec 5, 2023
Closed
7 tasks
rufuspollock
rufuspollock approved these changes Dec 5, 2023
View reviewed changes
Copy link
Member

@rufuspollock rufuspollock left a comment

Choose a reason for hiding this comment

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

Really like reviewing by README PR 👏👏

Whilst i think there may be some changes we could make this is good to approve and we discuss a bit more.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md
key3: 123,
key4: ["a", "b", "c"] // this will match exactly ["a", "b", "c"]
}
frontmatter: {
Copy link
Member

Choose a reason for hiding this comment

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

Can we do style guide stuff separately if we can - makes it easier to understand the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK

README.md Outdated
@@ -113,6 +115,70 @@ const blogs = await mddb.getFiles({
});
```

# Configuring `mddb.config.js`
Copy link
Member

Choose a reason for hiding this comment

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

What happened to our simple code config in the first version. I'd do that first ...

Overall this approach seems pretty sound and we would need it at some point. I'd just like to get the details right with some code before having to do config stuff.

README.md Outdated Show resolved Hide resolved
@rufuspollock rufuspollock merged commit 3ba2c81 into main Dec 6, 2023
2 of 3 checks passed
@mohamedsalem401 mohamedsalem401 deleted the readme branch February 8, 2024 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rufuspollock rufuspollock rufuspollock approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mohamedsalem401 @rufuspollock