Skip to content

Add deprecation banner to notify users of new API documentation location #7

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
Jul 16, 2025
Merged

Add deprecation banner to notify users of new API documentation location #7

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
367aa9e
Initial plan
Copilot Jul 16, 2025
a1a0803
Add deprecation banner to FluentCRM REST API documentation
Copilot Jul 16, 2025
d719161
Fix CSS syntax errors and complete deprecation banner implementation
Copilot Jul 16, 2025
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
12 changes: 12 additions & 0 deletions source/layouts/layout.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,18 @@ under the License.

<body class="<%= page_classes %>" data-languages="<%=h language_tabs.map{ |lang| lang.is_a?(Hash) ? lang.keys.first : lang }.to_json %>">

<!-- Deprecation Notice Banner -->
<div class="deprecation-banner">
<div class="deprecation-content">
<span class="deprecation-icon">⚠️</span>
<span class="deprecation-text">
<strong>Notice:</strong> This API documentation is no longer maintained.
Please visit the new documentation at
<a href="https://developers.fluentcrm.com/rest-api/" target="_blank" rel="noopener">developers.fluentcrm.com/rest-api</a>
</span>
</div>
</div>

<a href="#" id="nav-button">
<span>
NAV
Expand Down
79 changes: 78 additions & 1 deletion source/stylesheets/screen.css.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,84 @@ html, body {
@extend %default-font;
background-color: $main-bg;
height: 100%;
-webkit-text-size-adjust: none; /* Never autoresize text */
-webkit-text-size-adjust: none; /* Never autiresize text */
}

////////////////////////////////////////////////////////////////////////////////
// DEPRECATION BANNER
////////////////////////////////////////////////////////////////////////////////

.deprecation-banner {
position: fixed;
top: 0;
left: 0;
right: 0;
background: linear-gradient(135deg, #ff6b6b, #ee5a24);
color: white;
z-index: 9999;
padding: 12px 20px;
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.2);
border-bottom: 3px solid #c0392b;
}

.deprecation-content {
display: flex;
align-items: center;
justify-content: center;
max-width: 1200px;
margin: 0 auto;
font-size: 14px;
line-height: 1.4;
}

.deprecation-icon {
font-size: 18px;
margin-right: 10px;
flex-shrink: 0;
}

.deprecation-text {
text-align: center;

a {
color: #fff;
text-decoration: underline;
font-weight: 600;

&:hover {
color: #f1c40f;
text-decoration: none;
}
}

strong {
font-weight: 700;
}
}

// Adjust body padding to account for the banner
body {
padding-top: 60px;
}

@keyframes pulse {
0%, 100% { transform: scale(1); }
50% { transform: scale(1.1); }
}

// Adjust body content to account for fixed banner
body {
padding-top: 60px;
}

// Adjust the table of contents wrapper to account for banner
.toc-wrapper {
top: 60px;
}

// Adjust the page wrapper to account for banner
.page-wrapper {
margin-top: 60px;
}

////////////////////////////////////////////////////////////////////////////////
Expand Down