Update READMEs for repo & astro-ao3-loader
#22
Conversation
essential-randomness
force-pushed
the
ev-update-rehype-html-headings-readme
branch
from
bfff59f to
018cbc3
Compare
astro-ao3-loader/README.md
Outdated
|
|
||
| > [!TIP] | ||
| > Want to see it in action? Take a look at [our sample repository](https://github.com/FujoWebDev/ao3-content-layer-example). | ||
| > Want to see some examples? Take a look at [our sample repository](https://github.com/FujoWebDev/ao3-content-layer-example) or the [examples folder](/astro-ao3-loader/__examples__/). |
There was a problem hiding this comment.
I should probably fold that repo in here as an example so we don't need to keep it in sync. Unless you believe it could be useful to have a template repo people can start from that's separate from examples? In that case we may want to move it past just the loader and have a few different things in it that people might like. That's something I've wanted to do for a while.
Anyway, let me know your thoughts so I can make a mental note to update or remove that repo.
There was a problem hiding this comment.
Good idea—I think that it's best for ease of access and maintenance to fold them together. :) If we wanted to do a template, I think we could just include it as a separate folder in the __examples__ directory. 🤔
astro-ao3-loader/README.md
Outdated
| In this example, we'll use a loader called `worksLoader` that lets you get the details of a list of works whose IDs are listed in the `src/content/ao3/works.yaml` file. | ||
|
|
||
| To set it up, follow these steps: | ||
| The configuration steps are the same for each loader. In this example, we'll use the `worksLoader` to get information from a list of works specified in `src/content/ao3/works.yaml`. |
There was a problem hiding this comment.
I would link to the section above where you can find all different types of loaders.
astro-ao3-loader/README.md
Outdated
| > [!TIP] | ||
| > This file uses the YAML programming language to identify work IDs. If you're running into issues, check your syntax using one of the many YAML validators out there. | ||
|
|
||
| Once configured, you can use the `astro-ao3-loader` like any other Astro collection. |
There was a problem hiding this comment.
We'll likely want to link again to the content loader docs here.
There was a problem hiding this comment.
Would it make more sense to link to the "content collection" docs instead? 🤔
astro-ao3-loader/README.md
Outdated
| ``` | ||
|
|
||
| For a more complete example, you can take a look at [our sample repository](https://github.com/FujoWebDev/ao3-content-layer-example). No newline at end of file | ||
| ``` No newline at end of file |
There was a problem hiding this comment.
I would maybe still link to this specific page in our examples folder? it has stuff like tags and links which people may struggle with on their own.
astro-ao3-loader/README.md
Outdated
| ## What can `@fujocoded/astro-ao3-loader` do? | ||
|
|
||
| `@fujocoded/astro-ao3-loader` lets you easily grab data about content hosted on [Archive of Our Own](https://archiveofourown.org/) to use in your Astro website—however you wish to ✨ | ||
| You can use the following loaders to fetch data from [Archive of Our Own](https://archiveofourown.org/). |
There was a problem hiding this comment.
The reason I added the intro line in my review is that this section is meant to be in plain language, while "following loaders that fetch data" won't be understandable by anyone who doesn't know what a loader is (I have mixed feelings on fetch).
I would also say maybe "method" as a header table below has a similar issue, where we can just say "Loader" and make it clearer to those who don't know "method" without impacting the rest. Alternatively, "function" may be a middle ground and not incorrect.
Also, to further clarify a distinction I was making with the earlier version, " to use in your Astro website—however you wish to ✨" was an attempt to say "you're not bound to how we tell you to display the data, you can put it in your own HTML". I don't know that I loved it anyway.
There was a problem hiding this comment.
Sounds good! I'll add a brief intro back in and update the table header. :)
essential-randomness
left a comment
essential-randomness
left a comment
There was a problem hiding this comment.
....and it's done! I added a couple extra changes to wrap it all up (added loaders data path in the README + a screenshot of the example so people can see it in action without running it).
Thank you so much for your work, this is so useful and it's so appreciated ✨💖
essential-randomness
force-pushed
the
ev-update-rehype-html-headings-readme
branch
from
f12ce80 to
da03ba3
Compare
essential-randomness
deleted the
ev-update-rehype-html-headings-readme
branch
2 participants
No description provided.