Remove legacy window.ipfs examples
https://github.com/ipfs-shipyard/ipfs-companion/issues/589#issuecomment-712356448:
The
window.ipfsexperiment was disabled since last year (see https://github.com/ipfs-shipyard/ipfs-companion/pull/777 for rationale why).It did help us understand challenges and risks, and identified the need for more robust API for the web. We are officially putting
window.ipfsexperiment (in the form that was disabled in https://github.com/ipfs-shipyard/ipfs-companion/pull/777) in the Icebox and will be looking at other ways for node sharing and deduplication on the web in ipfs/in-web-browsers#158.If we revisit this approach, it will be a more robust API tailored for use on the web, and most likely happen after migration to Manifest V3 (https://github.com/ipfs-shipyard/ipfs-companion/pull/666).
Given that it has been off for most of this year and nobody complained, I'll be removing its presence from our docs and codebases:
- [x] disable in ipfs-companion (https://github.com/ipfs-shipyard/ipfs-companion/pull/777)
- [x] remove unused code and tests from https://github.com/ipfs-shipyard/ipfs-companion
- [ ] remove unused code and tests from https://github.com/ipfs-shipyard/ipfs-provider
- [ ] clean up docs and readme - switch https://docs.ipfs.io/how-to/companion-window-ipfs/ to be unlisted (removing from https://github.com/ipfs/ipfs-docs/blob/ec9655e11580af1a897ec7b004c863eb24f4cee1/docs/.vuepress/config.js takes it out of the nav, BUT it'll still show up in Algolia search) - truncate content to just inform about what it was (could be a rephrasing of first two sentences in text quoted on top of this issue) - remove reference in https://github.com/ipfs/ipfs-docs/blob/2cb827752782545914b184a9c04a41cbbda5dc37/docs/reference/js/api.md - remove reference in https://github.com/ipfs/ipfs-docs/blob/606cfdff028e3a7599f7199a13737ac3bca19598/docs/how-to/companion-node-types.md
- [ ] Move https://github.com/ipfs-shipyard/demo-ipfs-todo repo into
ipfs-inactiveorg - [ ] (TBD/optional) search for any third party libs and their docs and submit PRs/issues (if needed)
~~@jessicaschilling I can do the code cleanup, but you may be more familiar with the docs – is the page I linked the only place where we mention it?~~
@jessicaschilling I can do the code cleanup, but you may be more familiar with the docs – is the page I linked the only place where we mention it?
@lidel - I added the remaining (quick) docs mods to your original checklist, plus a suggestion to move https://github.com/ipfs-shipyard/demo-ipfs-todo repo into the ipfs-inactive org. Let me know if you want help with the docs stuff.