Skip to content

Commit 806b79c

Browse files
committed
fix: correct documentation URLs and heading visibility issues
1 parent 622e8e9 commit 806b79c

File tree

3 files changed

+74
-25
lines changed

3 files changed

+74
-25
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
# codebrief
44

5-
[![CI](https://github.com/Shorzinator/codebrief/workflows/codebrief%20CI/badge.svg)](https://github.com/Shorzinator/codebrief/actions)
6-
[![Coverage](https://img.shields.io/badge/coverage-77%25-yellow)](https://github.com/Shorzinator/codebrief)
5+
[![CI](https://github.com/Shorzinator/CodeBrief/workflows/CodeBrief%20CI/badge.svg)](https://github.com/Shorzinator/CodeBrief/actions)
6+
[![Coverage](https://img.shields.io/badge/coverage-77%25-yellow)](https://github.com/Shorzinator/CodeBrief)
77
[![Python](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
88
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
99
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -142,16 +142,16 @@ global_exclude_patterns = [
142142

143143
## Documentation
144144

145-
**[Live Documentation Website](https://shorzinator.github.io/codebrief/)**
145+
**[Live Documentation Website](https://shorzinator.github.io/CodeBrief/)**
146146

147147
Comprehensive documentation including:
148148

149-
- **[Getting Started](https://shorzinator.github.io/codebrief/getting-started/installation/)** - Installation and basic usage
150-
- **[CLI Commands](https://shorzinator.github.io/codebrief/user-guide/cli-commands/)** - Complete command reference
151-
- **[Configuration](https://shorzinator.github.io/codebrief/getting-started/configuration/)** - Advanced configuration options
152-
- **[API Reference](https://shorzinator.github.io/codebrief/reference/)** - Detailed API documentation
153-
- **[Examples](https://shorzinator.github.io/codebrief/examples/)** - Real-world usage examples
154-
- **[Tutorials](https://shorzinator.github.io/codebrief/tutorials/)** - Step-by-step guides
149+
- **[Getting Started](https://shorzinator.github.io/CodeBrief/getting-started/installation/)** - Installation and basic usage
150+
- **[CLI Commands](https://shorzinator.github.io/CodeBrief/user-guide/cli-commands/)** - Complete command reference
151+
- **[Configuration](https://shorzinator.github.io/CodeBrief/getting-started/configuration/)** - Advanced configuration options
152+
- **[API Reference](https://shorzinator.github.io/CodeBrief/reference/)** - Detailed API documentation
153+
- **[Examples](https://shorzinator.github.io/CodeBrief/examples/)** - Real-world usage examples
154+
- **[Tutorials](https://shorzinator.github.io/CodeBrief/tutorials/)** - Step-by-step guides
155155

156156
## Development
157157

@@ -165,8 +165,8 @@ Comprehensive documentation including:
165165

166166
```bash
167167
# Clone the repository
168-
git clone https://github.com/Shorzinator/codebrief.git
169-
cd codebrief
168+
git clone https://github.com/Shorzinator/CodeBrief.git
169+
cd CodeBrief
170170

171171
# Install dependencies
172172
poetry install --with dev
@@ -226,7 +226,7 @@ codebrief is actively developed and maintained. Current status:
226226

227227
<div align="center">
228228

229-
**[Documentation](https://shorzinator.github.io/codebrief/)[Issues](https://github.com/Shorzinator/codebrief/issues)[Discussions](https://shorzinator.github.io/codebrief/community/)**
229+
**[Documentation](https://shorzinator.github.io/CodeBrief/)[Issues](https://github.com/Shorzinator/CodeBrief/issues)[Discussions](https://shorzinator.github.io/CodeBrief/community/)**
230230

231231
Made for the developer community
232232

docs/javascripts/extra.js

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,48 @@
11
// Custom JavaScript for codebrief Documentation
22

3+
// Ensure headings are visible immediately
4+
document.documentElement.style.setProperty('--heading-visibility', 'visible');
5+
36
// Wait for DOM to be fully loaded
47
document.addEventListener('DOMContentLoaded', function() {
5-
6-
// Initialize all features
7-
initSmoothScrolling();
8-
initCodeCopyEnhancements();
9-
initScrollToTop();
10-
initProgressIndicator();
11-
initSearchEnhancements();
12-
initCardAnimations();
13-
initTableEnhancements();
14-
initThemeTransitions();
15-
initLEDEffects();
16-
17-
console.log('codebrief documentation enhanced! 🚀');
8+
// Ensure all headings are visible first
9+
ensureHeadingVisibility();
10+
11+
// Initialize all features with a small delay to prevent rendering issues
12+
setTimeout(() => {
13+
initSmoothScrolling();
14+
initCodeCopyEnhancements();
15+
initScrollToTop();
16+
initProgressIndicator();
17+
initSearchEnhancements();
18+
initCardAnimations();
19+
initTableEnhancements();
20+
initThemeTransitions();
21+
22+
// Initialize LED effects last to prevent interference
23+
setTimeout(() => {
24+
initLEDEffects();
25+
}, 100);
26+
27+
console.log('codebrief documentation enhanced! 🚀');
28+
}, 50);
1829
});
1930

31+
/**
32+
* Ensure headings are always visible
33+
*/
34+
function ensureHeadingVisibility() {
35+
const headings = document.querySelectorAll('h1, h2, h3, h4, h5, h6');
36+
headings.forEach(heading => {
37+
heading.style.opacity = '1';
38+
heading.style.visibility = 'visible';
39+
// Prevent text-fill-color issues during load
40+
if (getComputedStyle(heading).webkitTextFillColor === 'rgba(0, 0, 0, 0)') {
41+
heading.style.webkitTextFillColor = 'initial';
42+
}
43+
});
44+
}
45+
2046
/**
2147
* Enhanced smooth scrolling for anchor links
2248
*/

docs/stylesheets/extra.css

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
/* Custom CSS for codebrief Documentation */
22

3+
/* Prevent flash of invisible content - ensure headings are always visible */
4+
.md-typeset h1,
5+
.md-typeset h2,
6+
.md-typeset h3,
7+
.md-typeset h4,
8+
.md-typeset h5,
9+
.md-typeset h6 {
10+
opacity: 1 !important;
11+
visibility: visible !important;
12+
-webkit-text-fill-color: initial !important;
13+
}
14+
315
/* Root variables for consistent theming */
416
:root {
517
--cc-primary: #2563eb;
@@ -29,6 +41,17 @@
2941
font-size: 3rem;
3042
line-height: 1.1;
3143
margin-bottom: 1.5rem;
44+
/* Ensure visibility during load */
45+
opacity: 1 !important;
46+
visibility: visible !important;
47+
}
48+
49+
/* Fallback for browsers that don't support background-clip */
50+
@supports not (-webkit-background-clip: text) {
51+
.md-typeset h1:first-child {
52+
-webkit-text-fill-color: initial !important;
53+
color: var(--cc-primary-dark);
54+
}
3255
}
3356

3457
/* Hero section styling */

0 commit comments

Comments
 (0)