Giter VIP home page Giter VIP logo

Comments (5)

amartini51 avatar amartini51 commented on September 6, 2024

Fixed for chapters by #100, which also contains a proof of concept for section redirects.

from swift-book.

flbn avatar flbn commented on September 6, 2024

is this still open? repo links to https://docs.swift.org/swift-book/, which redirects to https://docs.swift.org/swift-book/documentation/the-swift-programming-language/ as opposed to the https://docs.swift.org/documentation/swift-book link mentioned above (which results in a 404)

from swift-book.

amartini51 avatar amartini51 commented on September 6, 2024

@flbn The url https://docs.swift.org/documentation/swift-book is the URL I originally expected to use. DocC has limitations on URLs, so we ended up publishing at https://docs.swift.org/swift-book/documentation/the-swift-programming-language/ instead.

If you see links to https://docs.swift.org/swift-book/ in a Swift project, please either open an issue or a PR to update the link. I'm not sure which place you mean by "repo".

This issue is still open, tracking the second issue in its description — redirection of links to sections.

from swift-book.

flbn avatar flbn commented on September 6, 2024

:0 sounds good, here's a quick PR: #113

from swift-book.

amartini51 avatar amartini51 commented on September 6, 2024

With the changes from #109 about 1/4 of the redirects still need to be manually filled in. Here's the process I've used to create those entries:

  1. Check out commit 94646f9 in a separate directory, which was the last RST version of the book.
  2. Identify a missing redirect in bin/redirects/redirect.swift by searching for docc: "" (an empty string).
  3. Do a case-insensitive search for that line's sphinx parameter in the RST source, replacing - with _ in the search term.
  4. If there's a search match, it will be right before the heading. Use the filename and the text of the heading to construct a DocC link, and write it in the docc parameter.
  5. If there are no matches, use git log -S or git log -G to find the commit where the Spinx writer-specified ID was changed, and repeat the search using the new name. Or, if the section was deleted, try to pick a fallback heading that contains the same content.

from swift-book.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.