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

(docs) Request for elaboration on usage docs for defineEntries #921

Open
tylersayshi opened this issue Sep 30, 2024 · 3 comments
Open

(docs) Request for elaboration on usage docs for defineEntries #921

tylersayshi opened this issue Sep 30, 2024 · 3 comments
Labels
good first issue Good for newcomers

Comments

@tylersayshi
Copy link
Contributor

defineEntries is a fn call to define how to render, build, and configure the ssr for your waku app.

Some initial usage docs live here: https://github.com/dai-shi/waku/blob/main/docs/minimal-api.mdx

It would be really helpful for someone new to look through how the initial usages of defineEntries are used, then summarize some info in a docs entry for this function.

I'd be happy to help answer questions and assist with writing some info up for this, but I think it would be a perfect task for anyone coming into the waku project looking for a starting point :)

@dai-shi dai-shi added the good first issue Good for newcomers label Sep 30, 2024
@ojj1123
Copy link
Contributor

ojj1123 commented Oct 1, 2024

I was wondering if you could explain where it is the explanation of defineEntries function in Docs or README! I couldn't find it since waku was released as v0.19.0. Is it deprecated

#24 (comment)

Oh I was also wondered defineEntries before releasing managed mode. If it's important to know this API for library authors, it's good to describe this API. Reading the source code of it briefly, It feels like it's working for build process. But it's too hard for newcomers to know about it.

const distEntries = await import(filePathToFileURL(distEntriesFile));

How about explain API descriptions like what each parameter work for or the interaction of parameters(renderEntries, getBuildConfig, getSsrConfig)? And then I feel like that it's easier to know and investigate the use cases of this API.

@rmarscher
Copy link
Contributor

rmarscher commented Nov 10, 2024

@dai-shi
Copy link
Owner

dai-shi commented Nov 11, 2024

We are in the middle of refactoring. defineEntries will be replaced with new_defineEntries soon-ish.

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

No branches or pull requests

4 participants