You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "miroim (via GitHub)" <gi...@apache.org> on 2025/04/14 05:15:53 UTC
[PR] docs(bindings/nodejs): fix broken links [opendal]
miroim opened a new pull request, #6017:
URL: https://github.com/apache/opendal/pull/6017
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
# Rationale for this change
- Fix broken links in nodejs binding docs:
- [Upgrade Guide](https://opendal.apache.org/docs/nodejs/upgrade.md)
- [Contributing Guide](https://opendal.apache.org/docs/nodejs/CONTRIBUTING.md)
- Fix the header for mobile page views
| before| after|
| --- | --- |
|<img src="https://github.com/user-attachments/assets/1e378972-b6b1-4695-b347-eea270e20dd1" width="281" height="500"> | <img src="https://github.com/user-attachments/assets/d9f03478-500d-4091-ae69-c66ea0489144" width="281" height="500">|
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
# What changes are included in this PR?
- Updated `typedoc` version from `^0.25` to `^0.28`
- Improve `typedoc` config to include the missing docs
- Refactor `FooterWithASFCopyright`
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking-changes` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/nodejs): fix broken links [opendal]
Posted by "yihong0618 (via GitHub)" <gi...@apache.org>.
yihong0618 commented on code in PR #6017:
URL: https://github.com/apache/opendal/pull/6017#discussion_r2041435723
##########
bindings/nodejs/tsconfig.theme.json:
##########
@@ -1,16 +1,17 @@
{
"compilerOptions": {
"target": "es2020",
- "module": "commonjs",
- "moduleResolution": "node",
+ "module": "NodeNext",
+ "moduleResolution": "nodenext",
Review Comment:
why change this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/nodejs): fix broken links [opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo merged PR #6017:
URL: https://github.com/apache/opendal/pull/6017
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/nodejs): fix broken links [opendal]
Posted by "miroim (via GitHub)" <gi...@apache.org>.
miroim commented on code in PR #6017:
URL: https://github.com/apache/opendal/pull/6017#discussion_r2041455702
##########
bindings/nodejs/package.json:
##########
@@ -5,6 +5,7 @@
"license": "Apache-2.0",
"main": "index.js",
"types": "index.d.ts",
+ "type": "module",
Review Comment:
I'll revert this change later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/nodejs): fix broken links [opendal]
Posted by "miroim (via GitHub)" <gi...@apache.org>.
miroim commented on code in PR #6017:
URL: https://github.com/apache/opendal/pull/6017#discussion_r2041452994
##########
bindings/nodejs/tsconfig.theme.json:
##########
@@ -1,16 +1,17 @@
{
"compilerOptions": {
"target": "es2020",
- "module": "commonjs",
- "moduleResolution": "node",
+ "module": "NodeNext",
+ "moduleResolution": "nodenext",
Review Comment:
FYI https://github.com/TypeStrong/typedoc/issues/2903#issuecomment-2733243351
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/nodejs): fix broken links [opendal]
Posted by "miroim (via GitHub)" <gi...@apache.org>.
miroim commented on code in PR #6017:
URL: https://github.com/apache/opendal/pull/6017#discussion_r2041455702
##########
bindings/nodejs/package.json:
##########
@@ -5,6 +5,7 @@
"license": "Apache-2.0",
"main": "index.js",
"types": "index.d.ts",
+ "type": "module",
Review Comment:
I'll revert this change later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org