Comments (11)
For example I can't seem to find any page documenting the vendored_frameworks DSL and someone searching how to reference a 3rd Party Framework in a podspec can't find a thing about that.
http://guides.cocoapods.org/syntax/podspec.html#vendored_frameworks
The documentation is derived from the comments of this file: https://github.com/CocoaPods/Core/blob/master/lib/cocoapods-core/specification/dsl.rb
from guides.cocoapods.org.
Oh, ok, nevermind, I didn't see the left-hand-side menu 😕.
But still, if someone asked me about this after searching the guides, and I wasn't able to find it myself either, maybe we could find a way to better document this.
I'll assign this to me then and think about how we can improve all this maybe (a search engine in the guides could be nice, though)
from guides.cocoapods.org.
I agree with you overall sentiment (also the location of that setting is far from being obvious). I don't think thug, that we should have a search engine... I would leave that to Google... just improving the description might go a long way, for example.
from guides.cocoapods.org.
I would leave that to Google...
The problem is that I did google for vendored_frameworks
in guides, and got only 2 results:
- one redirecting to the home of Guides
- the other to the syntax/podspec.html page, which does not show this
vendored_frameworks
up front when we arrive on it (that's why I didn't even think about clicking on the "File Patterns" on the left-hand-side menu to search for it)
Maybe some better SEO and URL-Rewriting would help (e.g. clicking on "File Patterns" on the left menu should change the URL to "/syntax/podspec/file-patterns.html" so that Google can redirect directly to the right page at least?)
from guides.cocoapods.org.
Confirmed on my side as well, Google always links to the root of http://guides.cocoapods.org/syntax/podspec.html and ignores the hash.
from guides.cocoapods.org.
hrm, yeah, as that stuff all comes from js I guess it is hard to provide google search stuff for.
This really requires a re-structuring of these pages at a pretty core level in order to make each one an individual URL. Perhaps we could move these two to a separate non-static site that is just for references like this.
from guides.cocoapods.org.
Improving the design by making it more clear that the menu on the left is expandable (thus "file patterns" does actually hide a submenu) would also help.
Either by adding some suggestion in the design that there is a submenu in there or by always keeping it expanded to show its submenu?
The users I see testing guides don't actually realize that there is more to it than just the page they are on, and the displayed/visible menu, thus missing a lot of information.
from guides.cocoapods.org.
Also I believe that the paragraph on the home page mentioning the links to the Podfile and podspec DSLs and CL-API are way too discreet
We also have you covered with references to the Podfile, the Podspec and our Command Line API.
We should make them part of the rest of the articles and not in a footnote kind of paragraph.
from guides.cocoapods.org.
I have a life issue orta/life#34 about this, but doubt I'll be able to come back to the guides for quite a while.
The problem with the DSLs is that there's a large tree of information that needs to be scoped, turning it to a bunch of pages is inelegant but gets google juice and could be an option, but it basically means re-writing the whole thing.
from guides.cocoapods.org.
Also we should document the JSON formats.
from guides.cocoapods.org.
I am officially withdrawing from this issue, because I don't know about Google SEO and how to resolve the fact that Google always link to root and all.
Note: This issue should maybe be closed so that we can reopen specific issues for the two problems? Namely:
- Improve Google SEO and a way for the menu to be always open (not my expertise at all)
- Document the JSON formats
from guides.cocoapods.org.
Related Issues (20)
- CocoaPods search api not working HOT 1
- Add documentation for vendored_frameworks HOT 3
- Add documentation for singular vs plural form of properties HOT 1
- Should the Manifest.lock file be added to git or not? HOT 9
- Google Map,Place, Picker Pod not installing HOT 2
- Google Map, Place, Picker HOT 1
- 请问如何遍历project或者遍历workspace的target HOT 1
- isssuuuussssseeee.secting
- ussrss.view HOT 1
- Can import a package of swiftpackage By using cocopods?
- how to push private reops HOT 1
- 更新到移动广告 SDK 7.15.0 或更高版本。
- sdk
- Learning
- pod 'Google-Mobile-Ads-SDK'
- could the symlink gcc issue be more prominent ? HOT 3
- Can I get pod install or pod update return result
- Unable to publish pod after successful push HOT 2
- Easily-to-fall-into Antipattern with Resource Bundle Names HOT 1
- How to include Privacy manifest in the static framework? How to tell cocoa-pods to embed the static framework?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from guides.cocoapods.org.