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

typedoc function pages are not loading on agoric-sdk.pages.dev #9729

Open
0xpatrickdev opened this issue Jul 18, 2024 · 0 comments
Open

typedoc function pages are not loading on agoric-sdk.pages.dev #9729

0xpatrickdev opened this issue Jul 18, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@0xpatrickdev
Copy link
Member

Describe the bug

Function pages (denoted with an F in the sidebar) are not loading on https://agoric-sdk.pages.dev.

#9727 (comment)

The white screen observed is for a 404 page. There are mimetype warnings in the console and these seem to be the result of broken relative links for .css and .js files in the /assets directory.

Typedoc publishes html files to the /functions directory, but CF Pages reserves that directory for worker functions: https://developers.cloudflare.com/pages/functions/get-started/#create-a-function

If you look at the "Assets Uploaded" tab for any CF build you will not observe a /functions directory or file uploads.

See: cloudflare/workers-sdk#2240

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://agoric-sdk.pages.dev/
  2. Navigate to the @agoric/ertp sidebar
  3. Click on 'F assertAssetKind' https://agoric-sdk.pages.dev/functions/_agoric_ertp.assertAssetKind.html
  4. See a white screen
  5. Open developer console which mentions a MIME type issue
    • This is a 404

Expected behavior

Functions pages should be visible.

Platform Environment

All

Screenshots
@0xpatrickdev 0xpatrickdev added the bug Something isn't working label Jul 18, 2024
0xpatrickdev added a commit that referenced this issue Jul 18, 2024
@0xpatrickdev
chore(docs): rename functions to funcs in typedoc output
e0b39cf 
- avoids limitation in cloudflare pages, where we cannot publish html files to a top-level functions directory
- closes: #9729
0xpatrickdev added a commit that referenced this issue Jul 18, 2024
@0xpatrickdev
chore(docs): rename functions to funcs in typedoc output
bbfc3ea 
- avoids limitation in cloudflare pages, where we cannot publish html files to a top-level functions directory
- closes: #9729
0xpatrickdev added a commit that referenced this issue Jul 18, 2024
@0xpatrickdev
chore(docs): rename functions to funcs in typedoc output
bf1c348 
- avoids limitation in cloudflare pages, where we cannot publish html files to a top-level functions directory
- closes: #9729
@0xpatrickdev 0xpatrickdev mentioned this issue Jul 18, 2024
Merged
@dckc dckc mentioned this issue Jul 31, 2024
Closed
mergify bot added a commit that referenced this issue Aug 8, 2024
@mergify
docs: bump typedoc to 0.26.4 (#9727)
e8c4189 
closes: #9681
refs: #9729

## Description

- Updates typedoc to latest version
- Adds script to rewrite `/functions` path to `/funcs` to avoid cloudflare/workers-sdk#2240
   - includes renaming files, anchor links in html files, and a base64 encoded navigation state object in a js file

### Security Considerations
n/a

### Scaling Considerations
n/a

### Documentation Considerations
n/a

### Testing Considerations
CI and manual QA

### Upgrade Considerations
n/a
@samsiegart samsiegart mentioned this issue Aug 8, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@0xpatrickdev