Skip to content

Commit e7021ef

Browse files
kaishintomerdalexandersandbergshahmishal
authored
Introduce top navigation (#450)
Co-authored-by: Tomer Doron <tomer@apple.com> Co-authored-by: Alexander Sandberg <hi@alexandersandberg.com> Co-authored-by: Mishal Shah <shahmishal@users.noreply.github.com>
1 parent 6213f0e commit e7021ef

File tree

92 files changed

+1421
-1300
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+1421
-1300
lines changed

_data/documentation.yaml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
- header: Overview
2+
pages:
3+
- title: Language Reference
4+
url: /documentation/tspl/
5+
description: |
6+
The Swift Programming Language (TSPL) book is the authoritative reference for Swift,
7+
offering a guided tour, a comprehensive guide, and a formal reference of the language.
8+
- title: API Design Guidelines
9+
url: /documentation/api-design-guidelines/
10+
description: |
11+
Delivering a clear, consistent developer experience when writing Swift code is largely defined by the names and idioms that appear in APIs.
12+
These design guidelines explain how to make sure that your code feels like a part of the larger Swift ecosystem
13+
- title: Standard Library
14+
url: /documentation/standard-library/
15+
description: |
16+
The Swift standard library defines a base layer of functionality for writing Swift programs.
17+
- title: Core Libraries
18+
url: /documentation/core-libraries/
19+
description: |
20+
The Swift Core Libraries project provides higher-level functionality than the Swift standard library.
21+
These libraries provide powerful tools that developers can depend upon across all the platforms Swift supports.
22+
- title: Package Manager
23+
url: /documentation/package-manager/
24+
description: |
25+
The Swift Package Manager is a tool for managing the distribution and use of "packages" of Swift code.
26+
It's integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies into target products.
27+
- title: REPL & Debugger
28+
url: /documentation/lldb/
29+
description: |
30+
The LLDB debugger provides a rich REPL as well as the debugging environment for the Swift Language.
31+
- title: About Swift
32+
url: /about/
33+
description: |
34+
A summary of the core features of Swift, supported platforms, and open source projects.
35+
#----------------------------------------------------
36+
- header: Articles
37+
pages:
38+
- title: Swift on Server
39+
url: /documentation/server/
40+
description: |
41+
Swift is a general-purpose programming language with unique characteristics that make it specifically suitable for Server applications
42+
- title: Mixing Swift and C++
43+
url: /documentation/cxx-interop/
44+
description: |
45+
Swift has support for bidirectional interoperability with C++.
46+
A great variety of C++ APIs can be called directly from Swift, and select Swift APIs can be used from C++.
47+
- title: Value and Reference types
48+
url: /documentation/articles/value-and-reference-types
49+
description: |
50+
Types in Swift are grouped in two categories: value types and reference types.
51+
Each behave differently and understanding the difference is an important part of understanding Swift.
52+
- title: DocC
53+
url: /documentation/docc/
54+
description: |
55+
DocC is a documentation compiler that makes it easy for you to produce documentation for your Swift frameworks and packages.
56+
The compiler builds your documentation by combining the comments you write in source with extension files, articles, and tutorials that live alongside your package's source code.
57+
#----------------------------------------------------
58+
- header: Contributing
59+
pages:
60+
- title: Swift Evolution
61+
url: /swift-evolution/
62+
description: |
63+
Swift evolution governs how changes are introduced to the Swift langague.
64+
The process details how ideas are proposed, discussed, reviewed, and eventually accepted into upcoming releases.
65+
- title: Source Code
66+
url: /documentation/source-code/
67+
description: |
68+
The code for the Swift project is divided into several open-source repositories, all hosted on GitHub.com.
69+
- title: Continuous Integration
70+
url: /documentation/continuous-integration/
71+
description: |
72+
Swift.org CI system produces the snapshot builds posted on swift.org, and runs tests against active branches.
73+
It is also used as part of the review process to run tests against pull requests before committing them.
74+
- title: Source Compatibility
75+
url: /documentation/source-compatibility/
76+
description: |
77+
Source compatibility test suite is a community owned resource designed to test for regressions
78+
in the compiler by building against a corpus of Swift source code.
79+
- title: Compiler Architecture
80+
url: /documentation/swift-compiler/
81+
description: |
82+
Overview of the Swift compiler architecture

_data/navigation.yml

Lines changed: 31 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -1,179 +1,33 @@
1-
- pages:
2-
- title: About Swift
3-
url: /about/
4-
sections:
5-
- title: Features
6-
name: features
7-
- title: Swift.org and Open Source
8-
name: swiftorg-and-open-source
9-
- title: Platform Support
10-
name: platform-support
11-
- title: Blog
12-
url: /blog/
13-
- title: Getting Started
14-
url: /getting-started/
15-
sections:
16-
- title: Installing Swift
17-
name: installing-swift
18-
- title: Using Swift
19-
name: using-swift
20-
- title: Go Further
21-
name: go-further
22-
- title: Install
23-
url: /install/
24-
sections:
25-
- title: macOS
26-
name: macos
27-
- title: Linux
28-
name: linux
29-
- title: Windows
30-
name: windows
31-
- title: Download
32-
url: /download/
33-
sections:
34-
- title: Releases
35-
name: releases
36-
- title: Snapshots
37-
name: snapshots
38-
- title: Installing Swift
39-
name: installing-swift
40-
- title: Packages
41-
url: /packages/
42-
sections:
43-
- title: Package Ecosystem
44-
name: package-ecosystem
45-
- title: Create Your Own
46-
name: create-your-own
47-
- title: Advanced Search
48-
name: advanced-search
49-
- title: Platform Support
50-
url: /platform-support/
51-
sections:
52-
- title: Deployment and Development
53-
name: deployment-and-development
54-
- title: Deployment-only
55-
name: deployment-only
56-
- title: Platform Owners
57-
name: platform-owners
1+
- header: Get Started
2+
url: /getting-started/
3+
# ------------------------------------------------------------------------------
4+
- header: Blog
5+
url: /blog/
586
# ------------------------------------------------------------------------------
597
- header: Documentation
8+
url: /documentation/
9+
# ------------------------------------------------------------------------------
10+
- header: Packages
11+
url: /packages/
6012
pages:
61-
- title: Overview
62-
url: /documentation/
63-
sections:
64-
- title: Swift Language
65-
name: swift-language
66-
- title: Standard Library
67-
name: standard-library
68-
- title: Packages
69-
name: packages
70-
- title: API Design Guidelines
71-
name: api-design-guidelines
72-
- title: C++ Interoperability
73-
name: mixing-swift-and-c
74-
- title: Tools
75-
name: tools
76-
- title: Swift Compiler
77-
url: /swift-compiler/
78-
sections:
79-
- title: Compiler Architecture
80-
name: compiler-architecture
81-
- title: Standard Library
82-
url: /standard-library/
83-
sections:
84-
- title: Standard Library Preview Package
85-
name: standard-library-preview-package
86-
- title: Standard Library Design
87-
name: standard-library-design
88-
- title: Package Manager
89-
url: /package-manager/
90-
sections:
91-
- title: Conceptual Overview
92-
name: conceptual-overview
93-
- title: Example Usage
94-
name: example-usage
95-
- title: Core Libraries
96-
url: /core-libraries/
97-
sections:
98-
- title: Foundation
99-
name: foundation
100-
- title: libdispatch
101-
name: libdispatch
102-
- title: xctest
103-
name: xctest
104-
- title: REPL, Debugger & Playgrounds
105-
url: /lldb/
106-
sections:
107-
- title: Combined REPL + Debugger
108-
name: why-combine-the-repl-and-debugger
109-
- title: Xcode Playgrounds
110-
name: xcode-playground-support
111-
- title: Swift on Server
112-
url: /server/
113-
sections:
114-
- title: Why Swift on Server?
115-
name: why-swift-on-server
116-
- title: Swift Server Workgroup
117-
name: swift-server-workgroup
118-
- title: Swift Server Guides
119-
name: development-guides
120-
- title: Swift Evolution
121-
url: /swift-evolution/
122-
- title: Source Code
123-
url: /source-code/
124-
sections:
125-
- title: Compiler and Standard Library
126-
name: compiler-and-standard-library
127-
- title: Core Libraries
128-
name: core-libraries
129-
- title: Package Manager
130-
name: package-manager
131-
- title: Xcode Playground Support
132-
name: xcode-playground-support
133-
- title: Source Tooling
134-
name: source-tooling
135-
- title: SourceKit-LSP Service
136-
name: sourcekit-lsp-service
137-
- title: Swift.org Website
138-
name: swiftorg-website
139-
- title: Cloned Repositories
140-
name: cloned-repositories
141-
- title: Continuous Integration
142-
url: /continuous-integration/
143-
sections:
144-
- title: Configuration
145-
name: configuration
146-
- title: Usage
147-
name: usage
148-
- title: Community Involvement
149-
name: community-involvement
150-
- title: Source Compatibility
151-
url: /source-compatibility/
152-
sections:
153-
- title: Current List of Projects
154-
name: current-list-of-projects
155-
- title: Adding Projects
156-
name: adding-projects
157-
- title: Maintaining Projects
158-
name: maintaining-projects
159-
- title: Pull Request Testing
160-
name: pull-request-testing
161-
- title: Building Projects
162-
name: building-projects
13+
- title: Community Showcase
14+
url: /packages/showcase.html
15+
- title: Packages with Macros
16+
url: /packages/macros.html
17+
- title: Server
18+
url: /packages/server.html
19+
- title: Networking
20+
url: /packages/networking.html
21+
- title: Testing
22+
url: /packages/testing.html
23+
- title: Debug Logging
24+
url: /packages/logging.html
16325
# ------------------------------------------------------------------------------
16426
- header: Community
27+
url: /community/
16528
pages:
166-
- title: Overview
167-
url: /community/
168-
sections:
169-
- title: Communication
170-
name: communication
171-
- title: Community Structure
172-
name: community-structure
173-
- title: License
174-
name: license
175-
- title: Forums
176-
name: forums
29+
- title: Swift Evolution
30+
url: /swift-evolution/
17731
- title: Diversity
17832
url: /diversity/
17933
sections:
@@ -217,10 +71,10 @@
21771
name: adding-external-library-dependencies
21872
- title: LLVM and Swift
21973
name: llvm-and-swift
220-
221-
- title: Contributor Experience Workgroup
74+
- section: Workgroups
75+
- title: Contributor Experience
22276
url: /contributor-experience-workgroup/
223-
- title: Server Workgroup
77+
- title: Server
22478
url: /sswg/
22579
sections:
22680
- title: Community Participation
@@ -229,7 +83,7 @@
22983
name: governance
23084
- title: Website workgroup
23185
name: website-workgroup
232-
- title: Website Workgroup
86+
- title: Website
23387
url: /website/
23488
sections:
23589
- title: Community Participation
@@ -253,7 +107,7 @@
253107
name: evolution-process
254108
- title: Community participation
255109
name: community-participation
256-
- title: C++ Interoperability Workgroup
110+
- title: C++ Interoperability
257111
url: /cxx-interop-workgroup/
258112
sections:
259113
- title: Charter
@@ -262,7 +116,7 @@
262116
name: membership
263117
- title: Communication
264118
name: communication
265-
- title: Documentation Workgroup
119+
- title: Documentation
266120
url: /documentation-workgroup/
267121
sections:
268122
- title: Charter
@@ -273,9 +127,7 @@
273127
name: communication
274128
- title: Community Participation
275129
name: community-participation
276-
# ------------------------------------------------------------------------------
277-
- header: Governance
278-
pages:
130+
- section: Governance
279131
- title: Code of Conduct
280132
url: /code-of-conduct/
281133
- title: License

_includes/getting-started/_installing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ If you don't have Swift installed, [install it first](/install).
44

55
To test that you have Swift installed, run `swift --version` from your shell or terminal app.
66

7-
Swift comes bundled with the [Swift Package Manager (SwiftPM)]({% link package-manager/index.md %}), which manages the distribution of your Swift code, and allows easy importing of other Swift packages into your apps.
7+
Swift comes bundled with the [Swift Package Manager (SwiftPM)]({% link documentation/package-manager/index.md %}), which manages the distribution of your Swift code, and allows easy importing of other Swift packages into your apps.

_includes/logo.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" viewBox="0 0 191.186 59.391"><path fill="#F05138" d="M59.387 16.45a82.463 82.463 0 0 0-.027-1.792c-.035-1.301-.112-2.614-.343-3.9-.234-1.307-.618-2.523-1.222-3.71a12.464 12.464 0 0 0-5.453-5.452C51.156.992 49.941.609 48.635.374c-1.288-.232-2.6-.308-3.902-.343a85.714 85.714 0 0 0-1.792-.027C42.23 0 41.52 0 40.813 0H18.578c-.71 0-1.419 0-2.128.004-.597.004-1.195.01-1.792.027-.325.009-.651.02-.978.036-.978.047-1.959.133-2.924.307-.98.176-1.908.436-2.811.81A12.503 12.503 0 0 0 3.89 3.89a12.46 12.46 0 0 0-2.294 3.158C.992 8.235.61 9.45.374 10.758c-.231 1.286-.308 2.599-.343 3.9a85.767 85.767 0 0 0-.027 1.792C-.001 17.16 0 17.869 0 18.578v22.235c0 .71 0 1.418.004 2.128.004.597.01 1.194.027 1.791.035 1.302.112 2.615.343 3.901.235 1.307.618 2.523 1.222 3.71a12.457 12.457 0 0 0 5.453 5.453c1.186.603 2.401.986 3.707 1.22 1.287.232 2.6.31 3.902.344.597.016 1.195.023 1.793.027.709.005 1.417.004 2.127.004h22.235c.709 0 1.418 0 2.128-.004.597-.004 1.194-.011 1.792-.027 1.302-.035 2.614-.112 3.902-.343 1.306-.235 2.521-.618 3.707-1.222a12.461 12.461 0 0 0 5.453-5.452c.604-1.187.987-2.403 1.222-3.71.231-1.286.308-2.6.343-3.9.016-.598.023-1.194.027-1.792.004-.71.004-1.419.004-2.129V18.578c0-.71 0-1.419-.004-2.128z"/><path fill="#FFF" d="m47.06 36.66-.004-.004c.066-.224.134-.446.191-.675 2.465-9.821-3.55-21.432-13.731-27.546 4.461 6.048 6.434 13.374 4.681 19.78-.156.571-.344 1.12-.552 1.653-.225-.148-.51-.316-.89-.527 0 0-10.127-6.252-21.103-17.312-.288-.29 5.852 8.777 12.822 16.14-3.284-1.843-12.434-8.5-18.227-13.802.712 1.187 1.558 2.33 2.489 3.43C17.573 23.932 23.882 31.5 31.44 37.314c-5.31 3.25-12.814 3.502-20.285.003a30.646 30.646 0 0 1-5.193-3.098c3.162 5.058 8.033 9.423 13.96 11.97 7.07 3.039 14.1 2.833 19.336.05l-.004.007c.024-.016.055-.032.08-.047.214-.116.428-.234.636-.358 2.516-1.306 7.485-2.63 10.152 2.559.654 1.27 2.041-5.46-3.061-11.74z"/><path id="logotype" d="M81.93 38.542c.465 4.12 4.394 6.822 9.852 6.822 5.185 0 8.924-2.701 8.924-6.44 0-3.22-2.265-5.185-7.478-6.495l-5.048-1.282c-7.26-1.801-10.534-5.077-10.534-10.48 0-6.658 5.813-11.27 14.082-11.27 8.022 0 13.726 4.639 13.917 11.325h-5.32c-.41-4.093-3.74-6.604-8.734-6.604-4.94 0-8.378 2.538-8.378 6.249 0 2.892 2.13 4.612 7.369 5.95l4.202 1.09c8.133 1.993 11.462 5.159 11.462 10.863 0 7.259-5.759 11.816-14.928 11.816-8.514 0-14.327-4.53-14.763-11.543h5.376zM140.049 49.43h-5.35l-6.249-21.776h-.109L122.12 49.43h-5.348l-7.914-28.518h5.184l5.513 22.896h.11l6.221-22.896h5.021l6.277 22.896h.11l5.512-22.896h5.13L140.05 49.43zM151.39 13.244c0-1.718 1.419-3.11 3.138-3.11 1.746 0 3.165 1.392 3.165 3.11 0 1.72-1.419 3.139-3.165 3.139a3.157 3.157 0 0 1-3.139-3.139zm.545 7.669h5.213V49.43h-5.213V20.913zM191.186 25.116v-4.204h-5.513v-6.821h-5.185v6.821h-9.964v-2.51c.027-2.538 1.01-3.603 3.357-3.603.764 0 1.528.083 2.156.192v-4.094a18.193 18.193 0 0 0-2.756-.218c-5.568 0-7.915 2.32-7.915 7.642v2.591h-3.983v4.204h3.983V49.43h5.185V25.116H180.488v16.838c0 5.512 2.101 7.64 7.559 7.64 1.174 0 2.51-.082 3.111-.218v-4.257c-.355.055-1.392.137-1.965.137-2.428 0-3.52-1.147-3.52-3.712V25.116h5.513z"/></svg>

0 commit comments

Comments
 (0)