Skip to content

docs: api docs design changes #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 15, 2022
Merged

docs: api docs design changes #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01be0c9
adding new template and update logo on apidocs
t1agob Feb 14, 2022
5e1d507
added footer to api docs
t1agob Feb 14, 2022
25edfe1
updated landing page for api docs
t1agob Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 10 additions & 21 deletions apidocs/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,10 @@
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
"files": ["api/**.yml", "api/index.md"]
},
{
"files": [
"toc.yml",
"*.md"
]
"files": ["toc.yml", "*.md"]
}
],
"resource": [
Expand All @@ -39,29 +33,24 @@
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
"files": ["apidoc/**.md"],
"exclude": ["obj/**", "_site/**"]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"globalMetadata": {
"_appTitle": "AWS Lambda Powertools for .NET",
"_appFaviconPath": "images/favicon.ico",
"_appLogoPath": "images/AWS_logo.png",
"_appLogoPath": "images/img.svg",
"_enableNewTab": true,
"_disableContribution": true
"_disableContribution": true,
"_enableSearch": "true",
"_appFooter": "AWS Lambda Powertools for .NET"
},
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"template": ["default", "templates/material"],
"postProcessors": ["ExtractSearchIndex"],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
Expand Down
Binary file removed apidocs/images/AWS_logo.png
View file
Open in desktop
Binary file not shown.
38 changes: 38 additions & 0 deletions apidocs/images/img.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 7 additions & 8 deletions apidocs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

Welcome to the *AWS Lambda Powertools for .NET* API reference. This documentation contains the API details for all supported utilities.

If you have any feedback, create a new issue in the *AWS Lambda Powertools for .NET* repository on GitHub.
To get started use the `API` menu on the navigation bar, or search for specific keywords on the search box on top-right corner of your screen.

### API reference
> [!NOTE]
> Are you looking for documentation on how to use AWS Lambda Powertools for .NET utilities and code samples?
>
> 👉 [Here](https://awslabs.github.io/aws-lambda-powertools-dotnet/) is the perfect place to start.

[AWS.Lambda.Powertools.Common](api/AWS.Lambda.Powertools.Common.html)
## Feedback

[AWS.Lambda.Powertools.Metrics](api/AWS.Lambda.Powertools.Metrics.html)

[AWS.Lambda.Powertools.Tracing](api/AWS.Lambda.Powertools.Tracing.html)

[AWS.Lambda.Powertools.Logging](api/AWS.Lambda.Powertools.Logging.html)
If you have any feedback, create a new issue in the *AWS Lambda Powertools for .NET* repository on [GitHub](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues).
21 changes: 21 additions & 0 deletions apidocs/templates/material/partials/head.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{{!Copyright (c) Oscar Vasquez. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
<meta name="generator" content="docfx {{_docfxVersion}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="{{_navRel}}">
<meta property="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
</head>
Loading