https://github.com/wormhole-foundation/docs.wormhole.com

Synced with GitBook
https://github.com/wormhole-foundation/docs.wormhole.com

Last synced: 4 days ago
JSON representation

Synced with GitBook

• Host: GitHub
• URL: https://github.com/wormhole-foundation/docs.wormhole.com
• Owner: wormhole-foundation
• Created: 2023-05-30T20:34:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-17T03:14:35.000Z (4 months ago)
• Last Synced: 2025-01-02T18:12:47.729Z (11 days ago)
• Language: TypeScript
• Size: 168 MB
• Stars: 18
• Watchers: 8
• Forks: 51
• Open Issues: 21
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Wormhole Docs

-------------

Developer docs for Wormhole

## Contributing

To contribute to the docs, 

1) Fork the repo 

2) Make the change locally and commit it to a new branch 

3) Open a pull request with a description of the change and motivation if necessary

4) Pat yourself on the back, you just helped a bunch of devs :raised-hands:

## Generating Content

There are scripts in the `/scripts` directory that are used to auto-generate content.

See the [README](./scripts/README.md) for details on running these scripts

Running `npm run check:links` should report any invalid links.

## Notes

The SUMMARY.md file is VERY picky, if you try to do something like have two top level (h1) headers, the CI job will never finish. If you're restructuring things, make small changes, CI for gitbook should be very fast.

Examples for writing GitBook flavored markdown: 

https://github.com/GitbookIO/git-sync-normalization/blob/master/api-blocks.md

https://support.audacityteam.org/community/contributing/tutorials/gitbook-markdown-syntax

You cannot include a dropdown in a tab or vice versa

Add a new line after the `{% hint %}` directive if you expect formatting like a link to work properly

Use a web utility to scan for dead links like https://www.deadlinkchecker.com/

> Note: Some urls will report 403 error because of geofencing 

Note there is some kind of caching maybe so weird stuff happens.

Ex: 

I moved files to new directories, updated nav, but links inside the cards were failing to resolve (href completely stripped from final html) but _only_ for those pages that had changes.

After removing all cards (so bad links wouldnt be published) and merging changes with the moved files, the same exact links worked in the preview.

/shrug