Skip to content

Commit 1526b69

Browse files
committed
Enhance site configuration and index page with improved content structure and relative link handling
Signed-off-by: DavidOsipov <[email protected]>
1 parent 2964989 commit 1526b69

File tree

2 files changed

+44
-7
lines changed

2 files changed

+44
-7
lines changed

site/_config.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,8 @@ defaults:
3535
layout: "default"
3636

3737
# Base URL
38-
baseurl: ""
38+
baseurl: ""
39+
40+
# Add this section to properly handle content from parent directories
41+
include_relative:
42+
enabled: true

site/index.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,57 @@ title: Home
55

66
# PostQuantum-Feldman-VSS
77

8-
{% include_relative ../README.md %}
8+
A post-quantum secure implementation of Feldman's Verifiable Secret Sharing scheme.
9+
10+
## Overview
11+
12+
This project provides a robust implementation of Feldman's VSS (Verifiable Secret Sharing) scheme with post-quantum security considerations. It enables secure sharing and reconstruction of secrets across multiple parties.
13+
14+
## Features
15+
16+
- Post-quantum secure cryptographic primitives
17+
- Threshold-based secret sharing
18+
- Verification mechanisms for shares
19+
- Compatible with modern Python environments
20+
21+
## Installation
22+
23+
```bash
24+
pip install feldman-vss
25+
```
26+
27+
## Quick Start
28+
29+
```python
30+
from feldman_vss import create_shares, reconstruct_secret
31+
32+
# Generate shares
33+
shares = create_shares(secret, total_shares, threshold)
34+
35+
# Reconstruct the secret
36+
secret = reconstruct_secret(shares)
37+
```
938

1039
## Frequently Asked Questions
1140

12-
{% include_relative ../docs/FAQ.md %}
41+
Please see the [FAQ](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/docs/FAQ.md) for common questions and answers.
1342

1443
## Security
1544

16-
{% include_relative ../SECURITY.md %}
45+
For security information, please refer to our [Security Policy](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/SECURITY.md).
1746

1847
## Code of Conduct
1948

20-
{% include_relative ../CODE_OF_CONDUCT.md %}
49+
Please review our [Code of Conduct](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/CODE_OF_CONDUCT.md).
2150

2251
## Contributing
2352

24-
{% include_relative ../CONTRIBUTING.md %}
53+
We welcome contributions! See our [Contributing Guide](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/CONTRIBUTING.md).
2554

2655
## Documentation
2756

28-
{% include_relative ../docs/DOCUMENTATION.md %}
57+
For detailed documentation, please visit our [Documentation](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/docs/DOCUMENTATION.md).
58+
59+
## License
60+
61+
This project is licensed under the terms found in the [LICENSE](https://github.com/DavidOsipov/PostQuantum-Feldman-VSS/blob/main/LICENSE) file.

0 commit comments

Comments
 (0)